Перейти к содержимому

List Deployments

GET
/v1/deployments
curl --request GET \
--url https://api.cloud.agentums.ru/v1/deployments \
--header 'Authorization: Bearer <token>'

Развёртывания владельца, свежие сверху. Снесённые в список не попадают.

slots_left — сколько машин ещё можно завести. Считает сервер: потолок его, и повторять правило в интерфейсе значит однажды показать доступную кнопку, которая отвечает отказом.

Successful Response

Media typeapplication/json
DeploymentList
object
agents_included
Any of:
integer
agents_limit
Any of:
integer
agents_used
Agents Used
integer
0
items
required
Items
Array<object>
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 format: date-time
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
error_hint
Error Hint
string
""
error_title
Error Title
string
""
id
required
Id
string format: uuid
last_health_at
Any of:
string format: date-time
latest_version
Latest Version
string
""
previous_version
Previous Version
string
""
ready_at
Any of:
string format: date-time
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
""
plan_title
Plan Title
string
""
slots_left
Slots Left
integer
0
Example
{
"agents_used": 0,
"items": [
{
"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": ""
}
],
"plan_title": "",
"slots_left": 0
}

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
Examplegenerated
{
"detail": [
{
"ctx": {},
"input": "example",
"loc": [
"example"
],
"msg": "example",
"type": "example"
}
]
}