Delete Deployment

DELETE

/v1/deployments/{deployment_id}

curl --request DELETE \
  --url https://api.cloud.agentums.ru/v1/deployments/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

• Прод

Снести машину и закрыть развёртывание.

Ответ приходит сразу с состоянием deleting: уборка идёт фоном и заканчивается только после подтверждения провайдера, что ресурса больше нет. Повторный вызов на уже закрытом развёртывании — успех, а не ошибка: уборку зовут в том числе после аварий.

Работает независимо от того, включён ли приём новых заявок. Выключенный флаг не должен делать уже поднятые машины неуправляемыми.

Authorizations

• bearerAuth

Parameters

Path Parameters

deployment_id

required

Deployment Id

string format: uuid

Responses

202

Successful Response

Media typeapplication/json

DeploymentOut

object

agent_slug

required

Agent Slug

string

attempts

Attempts

integer

0

bot_username

Bot Username

string

""

channels

Channels

object

key

additional properties

string

created_at

Any of:

string

string format: date-time

null

null

degraded

Degraded

Array<object>

DegradedOut

Одна отключённая интеграция агента.

name нужен поддержке — по нему ищут в журнале; человеку показывают title и hint. Держать их врозь важнее, чем кажется: без имени разбор обращения превращается в угадывание по тексту, а тексты правят.

object

hint

required

Hint

string

name

required

Name

string

title

required

Title

string

error_action

Error Action

string

""

error_code

Error Code

string

""

error_detail

Any of:

string

string

null

null

error_hint

Error Hint

string

""

error_title

Error Title

string

""

id

required

Id

string format: uuid

last_health_at

Any of:

string

string format: date-time

null

null

latest_version

Latest Version

string

""

previous_version

Previous Version

string

""

ready_at

Any of:

string

string format: date-time

null

null

reconverging

Reconverging

boolean

resources

Resources

object

key

additional properties

number

rollback_available

Rollback Available

boolean

skills

Skills

object

key

additional properties

any

status

required

Status

string

step

Step

integer

0

steps

Steps

integer

0

update_available

Update Available

boolean

update_error

Update Error

string

""

update_preparing

Update Preparing

boolean

version

Version

string

""

Example

{
  "attempts": 0,
  "bot_username": "",
  "error_action": "",
  "error_code": "",
  "error_hint": "",
  "error_title": "",
  "latest_version": "",
  "previous_version": "",
  "reconverging": false,
  "rollback_available": false,
  "step": 0,
  "steps": 0,
  "update_available": false,
  "update_error": "",
  "update_preparing": false,
  "version": ""
}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

ctx

Context

object

input

Input

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Example^generated

{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}