---
title: "Push status"
method: POST
path: "/orgs/{orgId}/projects/{projectId}/scout/status"
tags: ["Status"]
---

# Push status

`POST /orgs/{orgId}/projects/{projectId}/scout/status`

## Request

- Base URL: `https://app.cloud.redocly.com/api`
- URL: `https://app.cloud.redocly.com/api/orgs/{orgId}/projects/{projectId}/scout/status`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/redocly/apis/redocly-scout/docs/orgs/:orgId/projects/:projectId/scout/status/post.ts> (a function with typed inputs; its response is checked against the schema)

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

## Path parameters

- `orgId` string, required
- `projectId` string, required

## Headers

- `x-redocly-scout-version` string

## Request body

- Status
  - `hostname` string, required: Hostname of Scout instance.
  - `pid` integer, required: Process ID.
  - `version` string, required: Scout version.
  - `disk` object, required: Disk usage.
    - `size` integer, required: Total disk size.
    - `used` integer, required: Used disk size.
    - `available` integer, required: Available disk size.
    - `unit` 'B' | 'KB' | 'MB' | 'GB' | 'TB', required: Disk size unit.
  - `jobs` object, required: Scout jobs.
    - `active` integer, required: Number of active jobs.
    - `max` integer, required: Maximum number of jobs.

## Response `204`

No content.

## Other responses

- `400`: Bad Request.

---

[API](https://skmtc.dev/redocly/apis/redocly-scout.md) - [All operations](https://skmtc.dev/redocly/apis/redocly-scout/llms.txt) - [OpenAPI document](https://skmtc.dev/redocly/apis/redocly-scout/revisions/18944395275b?raw)
