# Check a deploy's blocks against what runs

POST

/v1/deployments/check

```sh
curl --request POST \
  --url https://example.com/v1/deployments/check \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "projectId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "agents": [ "example" ], "blocks": [ { "id": "example", "version": "example" } ], "replace": [ { "blockId": "example", "reason": "example" } ] }'
```

What `POST /v1/deployments` answers about the pack’s data blocks against what runs, with nothing written: `kindgi deploy` asks it before it builds the image. For each block, the newest version that runs in a project of one of `agents` (a project’s own version, or a segment pin inside one; every project, whoever asks) is compared with the body’s: a newer one stops the deploy unless `replace` names the block. Equal passes, a newer one in the files passes, and a block that runs nowhere passes. It takes the deploy’s own right: admin on `projectId`, else on the tenant.

## Authorizations

- **[bearerAuth](https://docs.kindgi.com/v0.4.0/reference/api.md#bearerauth)**

## Request Bodyrequired

application/json

object

**projectId**

The project the deploy goes into: the check takes the deploy’s own right, admin on it. Absent: the tenant’s default project, admin on the tenant. Every project of the pack’s agents counts, whichever this is.

string format: uuid

**agents**

required

The pack’s agents, by id: the image index’s.

Array\<string>

<= 500 items

**blocks**

required

The pack’s blocks, each at its version in the files; a block named once.

Array\<object>

<= 500 items

object

**id**

required

string

\>= 1 characters

**version**

required

string

**replace**

As the deploy’s `replace`: a block named once.

Array\<object>

object

**blockId**

required

string

\>= 1 characters

**reason**

required

Why the older version goes back: 1 to 500 characters, no control characters.

string

\>= 1 characters <= 500 characters

##### Examplegenerated

```json
{
  "projectId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "agents": [
    "example"
  ],
  "blocks": [
    {
      "id": "example",
      "version": "example"
    }
  ],
  "replace": [
    {
      "blockId": "example",
      "reason": "example"
    }
  ]
}
```

## Responses

### 200

The deploy can go: the blocks it puts back on purpose, and the ones `replace` names that need none.

application/json

object

**replaced**

required

The blocks `replace` names that a newer version runs for: the deploy puts each back, and records it.

Array\<object>

object

**blockId**

required

string

**from**

required

The newest version that runs now.

string

**to**

required

The files’ version.

string

**notNeeded**

required

The blocks `replace` names that nothing newer runs for: nothing to replace.

Array\<string>

##### Examplegenerated

```json
{
  "replaced": [
    {
      "blockId": "example",
      "from": "example",
      "to": "example"
    }
  ],
  "notNeeded": [
    "example"
  ]
}
```

### 400

`bad-input`: a body that isn’t `{ projectId?, agents, blocks, replace? }`, a block named twice, a version that isn’t one, or a `replace` reason that isn’t 1 to 500 characters with no control characters (`details.issues`).

application/json

object

**error**

required

object

**code**

required

Stable machine-readable discriminant. Values match domain error codes (see `docs/API-ROUTE-CONVENTIONS.md` §4.3).

string

**message**

required

string

**details**

Optional, kind-specific.

object

**_key_**

additional properties

any

**requestId**

required

Server-assigned request id; also echoed via `X-Request-Id` header.

string

##### Examplegenerated

```json
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}
```

### 401

Missing / malformed / expired / revoked bearer token.

application/json

object

**error**

required

object

**code**

required

Stable machine-readable discriminant. Values match domain error codes (see `docs/API-ROUTE-CONVENTIONS.md` §4.3).

string

**message**

required

string

**details**

Optional, kind-specific.

object

**_key_**

additional properties

any

**requestId**

required

Server-assigned request id; also echoed via `X-Request-Id` header.

string

##### Examplegenerated

```json
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}
```

### 403

No admin on `projectId` (`forbidden`), or a key limited to another project; without it, no admin on the tenant.

application/json

object

**error**

required

object

**code**

required

Stable machine-readable discriminant. Values match domain error codes (see `docs/API-ROUTE-CONVENTIONS.md` §4.3).

string

**message**

required

string

**details**

Optional, kind-specific.

object

**_key_**

additional properties

any

**requestId**

required

Server-assigned request id; also echoed via `X-Request-Id` header.

string

##### Examplegenerated

```json
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}
```

### 409

`deploy-would-put-back-older-blocks`, as `POST /v1/deployments` answers it: each block in `details.blocks` (`DeployCheckStop`).

application/json

object

**error**

required

object

**code**

required

Stable machine-readable discriminant. Values match domain error codes (see `docs/API-ROUTE-CONVENTIONS.md` §4.3).

string

**message**

required

string

**details**

Optional, kind-specific.

object

**_key_**

additional properties

any

**requestId**

required

Server-assigned request id; also echoed via `X-Request-Id` header.

string

##### Examplegenerated

```json
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}
```

### 413

The request body is over the API’s limit (`request-too-large`; `details.maxBytes` says how much).

application/json

object

**error**

required

object

**code**

required

Stable machine-readable discriminant. Values match domain error codes (see `docs/API-ROUTE-CONVENTIONS.md` §4.3).

string

**message**

required

string

**details**

Optional, kind-specific.

object

**_key_**

additional properties

any

**requestId**

required

Server-assigned request id; also echoed via `X-Request-Id` header.

string

##### Examplegenerated

```json
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}
```

### 501

`runs-in-unsupported`: this runtime doesn’t read the agents’ pins and Latest, or the agent versions that pin each block, so it can’t check; its deploys aren’t checked either.

application/json

object

**error**

required

object

**code**

required

Stable machine-readable discriminant. Values match domain error codes (see `docs/API-ROUTE-CONVENTIONS.md` §4.3).

string

**message**

required

string

**details**

Optional, kind-specific.

object

**_key_**

additional properties

any

**requestId**

required

Server-assigned request id; also echoed via `X-Request-Id` header.

string

##### Examplegenerated

```json
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}
```

## See also

- [Ship a pack from CI](https://docs.kindgi.com/v0.4.0/deploy/ship-from-ci.md)
- [Kindgi 0.4.0](https://docs.kindgi.com/v0.4.0/releases/0.4.0.md)
- [Error code `bad-input`](https://docs.kindgi.com/v0.4.0/reference/errors.md#bad-input)
- [Error code `deploy-would-put-back-older-blocks`](https://docs.kindgi.com/v0.4.0/reference/errors.md#deploy-would-put-back-older-blocks)
- [Error code `request-too-large`](https://docs.kindgi.com/v0.4.0/reference/errors.md#request-too-large)
- [Error code `runs-in-unsupported`](https://docs.kindgi.com/v0.4.0/reference/errors.md#runs-in-unsupported)
- [Every error code](https://docs.kindgi.com/v0.4.0/reference/errors.md)