К содержанию
TelegaFirst

Для AI-агентов: markdown этой страницы — /docs/api-op-getdomainstatus.mdиндекс документации — /llms.txt

getDomainStatus

Обновлено

GET /api/v1/tools/domain

Read tenant custom-domain status

Авторизация и права

Scopes: ALL. Auth alternatives: OR; scopes внутри альтернативы: ALL.

ПолеЗначение
security.0.hubApiKey[]
security.1.hubBearer[]
securitySchemes.hubApiKey.in"header"
securitySchemes.hubApiKey.name"X-Api-Key"
securitySchemes.hubApiKey.type"apiKey"
securitySchemes.hubBearer.scheme"bearer"
securitySchemes.hubBearer.type"http"
x-required-scopes["domain:read"]

Параметры запроса

ПолеЗначение
0.in"query"
0.name"zone"
0.requiredfalse
0.schema0.schema

Тело запроса

ПолеЗначение
Тело запросаnull

Ответы

ПолеЗначение
200.content.application/json.schemaDomainStatusList
200.description"Domain control-plane result; no internal row IDs"
200.headers.X-Bot-Username.description"Active bot username, when resolved"
200.headers.X-Bot-Username.schema200.headers.X-Bot-Username.schema
200.headers.X-Client-Slug.description"Active tenant slug, when resolved"
200.headers.X-Client-Slug.schema200.headers.X-Client-Slug.schema
200.headers.X-RateLimit-Limit.description"Effective request budget"
200.headers.X-RateLimit-Limit.schema200.headers.X-RateLimit-Limit.schema
200.headers.X-RateLimit-Remaining.description"Remaining request budget"
200.headers.X-RateLimit-Remaining.schema200.headers.X-RateLimit-Remaining.schema
200.headers.X-RateLimit-Reset.description"Unix window reset in seconds"
200.headers.X-RateLimit-Reset.schema200.headers.X-RateLimit-Reset.schema

Ошибки

ПолеЗначение
400.content.application/problem+json.schemaProblemDetails
400.description"Invalid strict zone query"
400.x-error-codes["VALIDATION_ERROR"]
401.content.application/problem+json.schemaProblemDetails
401.description"Missing, invalid, revoked or conflicting credential; surface JWT is refused"
401.x-error-codes["INVALID_API_KEY"]
403.content.application/problem+json.schemaProblemDetails
403.description"Missing scope, prohibited publishable credential or absent active bot"
403.x-error-codes["INSUFFICIENT_SCOPE","PUBLISHABLE_KEY_NOT_ALLOWED","NO_ACTIVE_BOT"]
413.content.application/problem+json.schemaProblemDetails
413.description"Resource policy size or item-count limit exceeded"
413.x-error-codes["PAYLOAD_TOO_LARGE","ITEM_COUNT_EXCEEDED"]
429.content.application/problem+json.schemaProblemDetails
429.description"Resource rate budget exceeded or unavailable"
429.headers.Retry-After.description"Retry delay in seconds, when supplied by the limiter"
429.headers.Retry-After.schema429.headers.Retry-After.schema
429.x-error-codes["RATE_LIMIT_EXCEEDED","RATE_LIMIT_UNAVAILABLE"]
500.content.application/problem+json.schemaProblemDetails
500.description"Unexpected internal failure"
500.x-error-codes["INTERNAL_ERROR"]

Дополнительные условия

ПолеЗначение
description"Returns every connected zone or one zone, resolved from credential tenant. Both ru and com are supported. Empty means no connection for this tenant. No pagination, ETag or idempotency contract. Bearer accepts tgf_* credentials; surface JWT is refused."
operationId"getDomainStatus"
summary"Read tenant custom-domain status"
tags["domain"]
x-idempotency.conflictStatusnull
x-idempotency.implementation"none"
x-idempotency.replayStatusnull
x-idempotency.requiredfalse
x-idempotency.scope[]
x-idempotency.ttlSecondsnull
x-pagination.queryParameters[]
x-pagination.supportedfalse
x-scope-semantics"ALL"