Redocly Scout (1.0)

Download OpenAPI description
openapi.json
openapi.yaml
Overview
API Support team@redocly.com
License Redocly
 Terms of Service
Languages
Servers
Mock server
https://redocly.com/_mock/docs/realm/scout/api/openapi/
Production main server.
https://{host}/api/

Remotes

Operations related to remotes.

Operations

Metadata

Operations related to metadata.

Operations

Todos

Operations related to todos.

Operations

Tasks

Operations related to tasks.

Operations

Status

Operations related to status.

Operations

Push status

Request

Scout uses this to periodically report it's status back to main api.

Path
orgIdstringrequired

Organization ID.

Example: acme-inc
projectIdstringrequired

Project ID.

Example: my-project
Headers
x-redocly-scout-versionstring

Scout version.

Example: 1.0.0
Bodyapplication/json
hostnamestringrequired

Hostname of Scout instance.

pidintegerrequired

Process ID.

versionstringrequired

Scout version.

diskobjectrequired

Disk usage.

disk.​sizeintegerrequired

Total disk size.

disk.​usedintegerrequired

Used disk size.

disk.​availableintegerrequired

Available disk size.

disk.​unitstringrequired

Disk size unit.

Enum"B""KB""MB""GB""TB"
Example: "MB"
jobsobjectrequired

Scout jobs.

jobs.​activeintegerrequired

Number of active jobs.

jobs.​maxintegerrequired

Maximum number of jobs.

curl -i -X POST \
  https://redocly.com/_mock/docs/realm/scout/api/openapi/orgs/acme-inc/projects/my-project/scout/status \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'x-redocly-scout-version: 1.0.0' \
  -d '{
    "hostname": "string",
    "pid": 0,
    "version": "string",
    "disk": {
      "size": 0,
      "used": 0,
      "available": 0,
      "unit": "MB"
    },
    "jobs": {
      "active": 0,
      "max": 0
    }
  }'

Responses

No content.

Response
No content