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

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

setSitePassword

Обновлено

PUT /api/v1/tools/site/passwords

Create or change a named password for closed sections of the site

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

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["site:write"]

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

ПолеЗначение
0.description"Tenant, credential and handler-bound byte-shape replay key"
0.in"header"
0.name"Idempotency-Key"
0.requiredfalse
0.schema0.schema

Тело запроса

ПолеЗначение
content.application/json.schemaSitePasswordRequest
requiredtrue

Ответы

ПолеЗначение
200.content.application/json.schemaSitePasswordSetResult
200.description"Tenant site control-plane result"
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 body"
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"]
409.content.application/problem+json.schemaProblemDetails
409.description"Typed domain conflict or request in flight"
409.x-error-codes["CONFLICT"]
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"]
422.content.application/problem+json.schemaProblemDetails
422.description"Replay key reused for different input; the password is shorter than 8 characters; the business is at its limit of passwords"
422.x-error-codes["IDEMPOTENCY_KEY_MISMATCH","SITE_PASSWORD_TOO_SHORT","SITE_PASSWORD_LIMIT"]
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"Owner-only site:write. One name is one password: a new name creates it, the same name takes the new password and signs out everyone who entered with the old one. name is lowercase letters, digits and hyphens (acme, course-2026); password is 8 to 128 characters; remember_days (1 to 365, default 30) is how long a visitor stays signed in on a device; note (up to 200 characters, one line) says who the password is for, absent keeps it and null clears it. A rule names the password in any_of of PUT /api/v1/tools/site/access-rules, and one password can serve many rules. The platform keeps the password: no listing shows it, and POST /api/v1/tools/site/passwords/{id}/reveal reads it back. Pass it to the audience yourself and keep it out of HTML, JS and bundle files. At most 100 passwords per business, on every plan. unprojected_hosts above 0 counts hosts whose edge catches up on the next reconciliation. The body carries the password, so the replay store never keeps it and no Idempotency-Key is read; a repeat is a change."
operationId"setSitePassword"
summary"Create or change a named password for closed sections of the site"
tags["site"]
x-idempotency.conflictStatus422
x-idempotency.implementation"global-cache"
x-idempotency.replayStatus200
x-idempotency.requiredfalse
x-idempotency.scope["client","credential","controller-handler","key"]
x-idempotency.ttlSeconds86400
x-pagination.queryParameters[]
x-pagination.supportedfalse
x-scope-semantics"ALL"