# Acknowledge an incident

- **OpenAPI Version:** `3.2.0`
- **API Version:** `3.1.0`
- **Contact:** Syndai <https://syndai.ai>

## Contents

**Operations**

- [POST /api/v1/external/coding/customers/{customer\_id}/projects/{project\_id}/alerts/incidents/{incident\_id}/ack](#scalar-operation-post-apiv1externalcodingcustomerscustomer-idprojectsproject-idalertsincidentsincident-idack)

**Schemas**

- [ProjectAlertsRead](#scalar-schema-projectalertsread)
- [IncidentRead](#scalar-schema-incidentread)
- [MonitorRead](#scalar-schema-monitorread)
- [RuleRead](#scalar-schema-ruleread)
- [ProblemDetail](#scalar-schema-problemdetail)
- [ExternalErrorCode](#scalar-schema-externalerrorcode)

<a id="scalar-context-global-servers"></a>

## Servers

- **URL:** `https://api.syndai.ai`

<a id="scalar-context-global-authentication"></a>

## Authentication

- **CustomerApiKey**: HTTP bearer (`API Key`)

  Customer API key sent as a bearer token

## Tags

### Apps

Beta: may change without notice. Publishing a repository as a hosted app: publish, unpublish, read and update a publication, its deployments, custom domain, runtime and monthly AI limit, and export its data or waitlist.

## Operations

<a id="scalar-operation-post-apiv1externalcodingcustomerscustomer-idprojectsproject-idalertsincidentsincident-idack"></a>

### Acknowledge an incident

- **Method:** `POST`
- **Path:** `/api/v1/external/coding/customers/{customer_id}/projects/{project_id}/alerts/incidents/{incident_id}/ack`
- **Operation ID:** `ackIncident`
- **Tags:** Apps

Marks an open incident `acked`: it stops escalating to the workspace's other owners and admins, and still resolves on its own when the rule clears. 404 when no open incident has this id.

**Servers:** [Inherited servers](#scalar-context-global-servers)

**Authentication:** [Global authentication](#scalar-context-global-authentication)

#### Path parameters

- **`customer_id` (required)**: `string`, format: `uuid`
- **`project_id` (required)**: `string`, format: `uuid`
- **`incident_id` (required)**: `string`, format: `uuid`

#### Responses

##### 200 Request fulfilled, document follows

**Content type:** `application/json`

[ProjectAlertsRead](#scalar-schema-projectalertsread)

<a id="scalar-example-1"></a>

**Generated example:**

```json
{
  "incidents": [
    {
      "acked_at": "",
      "id": "",
      "metric": "",
      "opened_at": "",
      "resolved_at": "",
      "rule_key": "",
      "snapshot": {
        "additionalProperty": "anything"
      },
      "state": "",
      "summary": "",
      "timeline": [
        {
          "additionalProperty": "anything"
        }
      ],
      "title": "",
      "trusted": true
    }
  ],
  "monitors": [
    {
      "every_s": 1,
      "grace_s": 1,
      "last_fail_at": "",
      "last_ok_at": "",
      "name": ""
    }
  ],
  "rules": [
    {
      "fire_at": 1,
      "firing": true,
      "key": "",
      "kind": "",
      "last_value": 1,
      "metric": "",
      "muted": true,
      "params": {
        "additionalProperty": "anything"
      },
      "title": ""
    }
  ],
  "site_id": ""
}
```

##### 400, 401, 403, 404

- `400` Bad request syntax or unsupported method
- `401` Invalid or missing customer API key
- `403` Insufficient scope or forbidden customer access
- `404` Resource not found

**Content type:** `application/problem+json`

[ProblemDetail](#scalar-schema-problemdetail)

RFC 7807 problem detail returned for public CaaS errors.

<a id="scalar-example-2"></a>

**Generated example:**

```json
{
  "code": "BUDGET_EXHAUSTED",
  "detail": null,
  "existing_run_id": null,
  "instance": null,
  "status": 1,
  "title": "",
  "type": "about:blank",
  "additionalProperty": "anything"
}
```

##### 429 Rate limit exceeded

**Headers:**

- **`Retry-After`**

  Seconds to wait before retrying the request

  `integer`

**Content type:** `application/problem+json`

[ProblemDetail](#scalar-schema-problemdetail)

RFC 7807 problem detail returned for public CaaS errors.

[Generated example](#scalar-example-2)

##### default Unexpected error

**Content type:** `application/problem+json`

[ProblemDetail](#scalar-schema-problemdetail)

<a id="scalar-example-3"></a>

**Generated example:**

```json
null
```

## Schemas

<a id="scalar-schema-projectalertsread"></a>

### ProjectAlertsRead

**Type:** `object`

- **`incidents` (required)**: array of [IncidentRead](#scalar-schema-incidentread)
- **`rules` (required)**: array of [RuleRead](#scalar-schema-ruleread)
- **`monitors`**: array of [MonitorRead](#scalar-schema-monitorread)
- **`site_id`**: `string | null`, format: `uuid`

<a id="scalar-example-4"></a>

**Generated example:**

```json
{
  "incidents": [
    {
      "acked_at": "",
      "id": "",
      "metric": "",
      "opened_at": "",
      "resolved_at": "",
      "rule_key": "",
      "snapshot": {
        "additionalProperty": "anything"
      },
      "state": "",
      "summary": "",
      "timeline": [
        {
          "additionalProperty": "anything"
        }
      ],
      "title": "",
      "trusted": true
    }
  ],
  "monitors": [
    {
      "every_s": 1,
      "grace_s": 1,
      "last_fail_at": "",
      "last_ok_at": "",
      "name": ""
    }
  ],
  "rules": [
    {
      "fire_at": 1,
      "firing": true,
      "key": "",
      "kind": "",
      "last_value": 1,
      "metric": "",
      "muted": true,
      "params": {
        "additionalProperty": "anything"
      },
      "title": ""
    }
  ],
  "site_id": ""
}
```

<a id="scalar-schema-incidentread"></a>

### IncidentRead

**Type:** `object`

- **`id` (required)**: `string`, format: `uuid`
- **`metric` (required)**: `string`
- **`opened_at` (required)**: `string`
- **`rule_key` (required)**: `string`
- **`snapshot` (required)**: `object`
- **`state` (required)**: `string`
- **`summary` (required)**: `string`
- **`timeline` (required)**: `array of object`
- **`title` (required)**: `string`
- **`trusted` (required)**: `boolean`
- **`acked_at`**: `string | null`
- **`resolved_at`**: `string | null`

<a id="scalar-example-5"></a>

**Generated example:**

```json
{
  "acked_at": "",
  "id": "",
  "metric": "",
  "opened_at": "",
  "resolved_at": "",
  "rule_key": "",
  "snapshot": {
    "additionalProperty": "anything"
  },
  "state": "",
  "summary": "",
  "timeline": [
    {
      "additionalProperty": "anything"
    }
  ],
  "title": "",
  "trusted": true
}
```

<a id="scalar-schema-monitorread"></a>

### MonitorRead

**Type:** `object`

- **`name` (required)**: `string`
- **`every_s`**: `integer | null`
- **`grace_s`**: `integer | null`
- **`last_fail_at`**: `string | null`
- **`last_ok_at`**: `string | null`

<a id="scalar-example-6"></a>

**Generated example:**

```json
{
  "every_s": 1,
  "grace_s": 1,
  "last_fail_at": "",
  "last_ok_at": "",
  "name": ""
}
```

<a id="scalar-schema-ruleread"></a>

### RuleRead

**Type:** `object`

- **`fire_at` (required)**: `integer`
- **`firing` (required)**: `boolean`
- **`key` (required)**: `string`
- **`kind` (required)**: `string`
- **`metric` (required)**: `string`
- **`muted` (required)**: `boolean`
- **`params` (required)**: `object`
- **`title` (required)**: `string`
- **`last_value`**: `number | null`

<a id="scalar-example-7"></a>

**Generated example:**

```json
{
  "fire_at": 1,
  "firing": true,
  "key": "",
  "kind": "",
  "last_value": 1,
  "metric": "",
  "muted": true,
  "params": {
    "additionalProperty": "anything"
  },
  "title": ""
}
```

<a id="scalar-schema-problemdetail"></a>

### ProblemDetail

**Type:** `object`

RFC 7807 problem detail returned for public CaaS errors.

- **`code` (required)**: `string`, possible values: `"BUDGET_EXHAUSTED", "QUOTA_EXCEEDED", "RUN_CONCURRENCY_LIMIT", "CUSTOMER_DISABLED", "REPO_NOT_BOUND", "IDEMPOTENCY_REPLAY", "CONFLICT", "MISSION_BUSY_RETRY", "HITL_REQUEST_CONFLICT", "HITL_REQUEST_SETTLED", "RUN_TERMINATED_BEFORE_RESPONSE", "INVALID_POLICY", "INVALID_SCOPE", "RATE_LIMITED", "INSTALLATION_INCOMPLETE", "SUBSCRIPTION_USAGE_UNAVAILABLE", "INVALID_TOKEN", "ROLE_REQUIRED", "PLAN_UPGRADE_REQUIRED", "EMAIL_MISMATCH", "EXPIRED_TOKEN", "NOT_FOUND", "OVERSCOPE_ACK_REQUIRED", "VERIFY_FAILED", "PUBLISH_IN_FLIGHT", "PUBLISH_UNSUPPORTED_REPO", "PUBLICATION_NOT_LIVE", "NO_APP_DATA", "FEATURE_REQUESTS_NEEDS_MEMBERS", "EMPTY_UPDATE", "BAD_CURSOR", "HUMAN_APPROVAL_REQUIRED", "PROTECTED_PATHS_MANAGED_ONLY", "RUN_IN_FLIGHT", "TEXT_EDIT_REFUSED", "CLI_UPGRADE_REQUIRED", "PRODUCTION_STEP_UP_REQUIRED", "PRICES_UPDATING", "GITHUB_UNAVAILABLE", "PUBLISH_NOT_SET_UP", "PUBLISH_TAG_EXISTS", "PUBLISH_VERSION_EXISTS", "VERSION_NOT_DEPLOYED", "DATA_REFUSED", "INTERNAL_ERROR"`

  Stable error codes surfaced to public CaaS clients.
- **`status` (required)**: `integer`
- **`title` (required)**: `string`
- **`detail`**: `string | null`, default: `null`
- **`existing_run_id`**: `string | null`, default: `null`
- **`instance`**: `string | null`, default: `null`
- **`type`**: `string`, default: `"about:blank"`

<a id="scalar-example-8"></a>

**Generated example:**

```json
{
  "code": "BUDGET_EXHAUSTED",
  "detail": null,
  "existing_run_id": null,
  "instance": null,
  "status": 1,
  "title": "",
  "type": "about:blank",
  "additionalProperty": "anything"
}
```

<a id="scalar-schema-externalerrorcode"></a>

### ExternalErrorCode

**Type:** `string`, possible values: `"BUDGET_EXHAUSTED", "QUOTA_EXCEEDED", "RUN_CONCURRENCY_LIMIT", "CUSTOMER_DISABLED", "REPO_NOT_BOUND", "IDEMPOTENCY_REPLAY", "CONFLICT", "MISSION_BUSY_RETRY", "HITL_REQUEST_CONFLICT", "HITL_REQUEST_SETTLED", "RUN_TERMINATED_BEFORE_RESPONSE", "INVALID_POLICY", "INVALID_SCOPE", "RATE_LIMITED", "INSTALLATION_INCOMPLETE", "SUBSCRIPTION_USAGE_UNAVAILABLE", "INVALID_TOKEN", "ROLE_REQUIRED", "PLAN_UPGRADE_REQUIRED", "EMAIL_MISMATCH", "EXPIRED_TOKEN", "NOT_FOUND", "OVERSCOPE_ACK_REQUIRED", "VERIFY_FAILED", "PUBLISH_IN_FLIGHT", "PUBLISH_UNSUPPORTED_REPO", "PUBLICATION_NOT_LIVE", "NO_APP_DATA", "FEATURE_REQUESTS_NEEDS_MEMBERS", "EMPTY_UPDATE", "BAD_CURSOR", "HUMAN_APPROVAL_REQUIRED", "PROTECTED_PATHS_MANAGED_ONLY", "RUN_IN_FLIGHT", "TEXT_EDIT_REFUSED", "CLI_UPGRADE_REQUIRED", "PRODUCTION_STEP_UP_REQUIRED", "PRICES_UPDATING", "GITHUB_UNAVAILABLE", "PUBLISH_NOT_SET_UP", "PUBLISH_TAG_EXISTS", "PUBLISH_VERSION_EXISTS", "VERSION_NOT_DEPLOYED", "DATA_REFUSED", "INTERNAL_ERROR"`

Stable error codes surfaced to public CaaS clients.