Layero Claimable API
The claimable API from Layero — 5 operation(s) for claimable.
The claimable API from Layero — 5 operation(s) for claimable.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/layero-ru:layero-ru-claimable-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Layero Claimable API
version: 0.1.0
tags:
- name: claimable
paths:
/claimable/projects:
post:
tags:
- claimable
summary: Create Claimable Project
description: 'Завести песочницу без аккаунта.
Возвращает токен со скоупом deploy (обычный `layero_ci_*`, привязан к
держателю песочницы) и ссылку `claim_url`, по которой человек заберёт
проект в свой аккаунт. Песочница живёт час.'
operationId: create_claimable_project_claimable_projects_post
requestBody:
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/ClaimableCreateIn'
- type: 'null'
title: Payload
responses:
'201':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ClaimableCreateOut'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/claimable/status:
get:
tags:
- claimable
summary: Claimable Status
description: 'Состояние песочницы по коду забора. Без аутентификации: ссылку
показывает агент, а открывает человек, у которого сессии может не быть.'
operationId: claimable_status_claimable_status_get
parameters:
- name: code
in: query
required: true
schema:
type: string
minLength: 8
maxLength: 200
title: Code
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ClaimableStatusOut'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/claimable/discard:
post:
tags:
- claimable
summary: Discard Sandbox
description: 'Отказаться от песочницы до срока — кнопка «Попробовать ещё раз» на
layero.ru/create: временный сайт у посетителя один, новый — вместо старого.
Без аутентификации, право даёт код забора: он есть только у создателя.
Срок становится «сейчас»: адрес гаснет немедленно, файлы и строки снимает
обычная уборка в течение минуты. Забранную и уже истёкшую не трогаем.'
operationId: discard_sandbox_claimable_discard_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ClaimIn'
required: true
responses:
'204':
description: Successful Response
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/claimable/preview/{label}:
get:
tags:
- claimable
summary: Claimable Preview
description: 'Что показать странице `/preview/`: адрес сайта и срок.
Метка публична — это первая часть адреса сайта, её и так видит каждый, кому
дали ссылку. Кода забора ручка не знает и не отдаёт. Забранный, истёкший и
несуществующий сайт неразличимы: 404.'
operationId: claimable_preview_claimable_preview__label__get
parameters:
- name: label
in: path
required: true
schema:
type: string
title: Label
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ClaimablePreviewOut'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/claimable/claim:
post:
tags:
- claimable
summary: Claim Project
description: 'Забрать песочницу в личную организацию.
Механика та же, что у принятия передачи проекта (`project_transfer.accept`),
без ветвей про GitHub: у песочницы нет ни репозитория, ни вебхука.
Адрес МЕНЯЕТСЯ: временный `.preview.layero.app` гаснет, сайт
переезжает на постоянный `.layero.app` в зоне нового владельца
(`_move_to_permanent_address`). Песочница, родившаяся до зоны preview, уже
живёт в зоне проектов — её адрес остаётся прежним.
🚨 Всё, что анонимная сторона могла оставить в проекте, СНИМАЕТСЯ
(T-20260921): переменные окружения, хуки деплоя и настройки сборки. Иначе
«готовый сайт по ссылке» — троян: подложенная команда установки или реестр
пакетов в переменной исполнялись бы на сборках нового владельца, а хук
запускал бы их снаружи. Выложенные файлы остаются — сайт продолжает
работать; страница забора говорит об этом до нажатия. Административный маршрут (`ADMIN_ROUTES`): забор — то же
принятие передачи, и токен без `admin` его делать не должен.'
operationId: claim_project_claimable_claim_post
parameters:
- name: authorization
in: header
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Authorization
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ClaimIn'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectOut'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
ProjectOut:
properties:
id:
type: string
format: uuid
title: Id
name:
type: string
title: Name
slug:
type: string
title: Slug
apex_hostname:
type: string
title: Apex Hostname
organization:
$ref: '#/components/schemas/OrganizationInline'
repo_url:
anyOf:
- type: string
- type: 'null'
title: Repo Url
repo_full_name:
anyOf:
- type: string
- type: 'null'
title: Repo Full Name
default_branch:
type: string
title: Default Branch
source_type:
type: string
title: Source Type
default: github
source_provider:
anyOf:
- type: string
- type: 'null'
title: Source Provider
github_integration_enabled:
type: boolean
title: Github Integration Enabled
default: false
cli_deploys_enabled:
type: boolean
title: Cli Deploys Enabled
default: true
redeploy_available:
anyOf:
- type: boolean
- type: 'null'
title: Redeploy Available
framework_hint:
anyOf:
- type: string
- type: 'null'
title: Framework Hint
build_cmd:
anyOf:
- type: string
- type: 'null'
title: Build Cmd
output_dir:
anyOf:
- type: string
- type: 'null'
title: Output Dir
start_cmd:
anyOf:
- type: string
- type: 'null'
title: Start Cmd
port:
anyOf:
- type: integer
- type: 'null'
title: Port
preset:
anyOf:
- $ref: '#/components/schemas/ProjectPresetOut'
- type: 'null'
package_manager:
anyOf:
- type: string
- type: 'null'
title: Package Manager
node_version:
anyOf:
- type: string
- type: 'null'
title: Node Version
root_directory:
anyOf:
- type: string
- type: 'null'
title: Root Directory
cancel_superseded:
type: boolean
title: Cancel Superseded
default: true
auto_deploy_on_push:
type: boolean
title: Auto Deploy On Push
default: true
auto_deploy_paused_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Auto Deploy Paused At
auto_deploy_pause_streak:
anyOf:
- type: integer
- type: 'null'
title: Auto Deploy Pause Streak
auto_deploy_pause_deploy_id:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Auto Deploy Pause Deploy Id
auto_deploy_pause_error:
anyOf:
- type: string
- type: 'null'
title: Auto Deploy Pause Error
auto_deploy_pause_scope:
anyOf:
- type: string
- type: 'null'
title: Auto Deploy Pause Scope
auth_enabled:
type: boolean
title: Auth Enabled
default: false
auth_realm_name:
anyOf:
- type: string
- type: 'null'
title: Auth Realm Name
indexing_enabled:
type: boolean
title: Indexing Enabled
default: false
created_at:
type: string
format: date-time
title: Created At
has_in_flight:
type: boolean
title: Has In Flight
default: false
default_env_ready:
type: boolean
title: Default Env Ready
default: false
last_failed_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Last Failed At
publish_status:
type: string
title: Publish Status
default: unknown
apex_cdn_ready:
type: boolean
title: Apex Cdn Ready
default: false
retired_hostnames:
items:
type: string
type: array
title: Retired Hostnames
default: []
retired_until:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Retired Until
project_type:
type: string
title: Project Type
default: spa
fullstack_config:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Fullstack Config
project_type_suggestion:
anyOf:
- type: string
- type: 'null'
title: Project Type Suggestion
build_settings_suggestion:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Build Settings Suggestion
runtime_instance_tier:
anyOf:
- type: string
- type: 'null'
title: Runtime Instance Tier
status:
type: string
title: Status
default: active
repo_status:
type: string
title: Repo Status
default: connected
github_app_installation_id:
anyOf:
- type: integer
- type: 'null'
title: Github App Installation Id
installation_state:
anyOf:
- type: string
- type: 'null'
title: Installation State
my_role:
type: string
title: My Role
default: viewer
production_deploy_id:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Production Deploy Id
previous_production_deploy_id:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Previous Production Deploy Id
auto_promote_default_branch:
type: boolean
title: Auto Promote Default Branch
default: true
production_pointer_enabled:
type: boolean
title: Production Pointer Enabled
default: false
member_count:
type: integer
title: Member Count
default: 1
production_branch_name:
anyOf:
- type: string
- type: 'null'
title: Production Branch Name
branding_enabled:
type: boolean
title: Branding Enabled
default: true
footer_color:
anyOf:
- type: string
- type: 'null'
title: Footer Color
is_suspended:
type: boolean
title: Is Suspended
default: false
is_manually_suspended:
type: boolean
title: Is Manually Suspended
default: false
is_blocked:
type: boolean
title: Is Blocked
default: false
runtime_last_failure_reason:
anyOf:
- type: string
- type: 'null'
title: Runtime Last Failure Reason
runtime_last_failed_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Runtime Last Failed At
runtime_memory_advisory:
anyOf:
- type: string
- type: 'null'
title: Runtime Memory Advisory
runtime_memory_advisory_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Runtime Memory Advisory At
favicon_url:
anyOf:
- type: string
- type: 'null'
title: Favicon Url
type: object
required:
- id
- name
- slug
- apex_hostname
- organization
- default_branch
- created_at
title: ProjectOut
ClaimableCreateOut:
properties:
project_id:
type: string
format: uuid
title: Project Id
slug:
type: string
title: Slug
organization:
type: string
title: Organization
url:
type: string
title: Url
preview_url:
type: string
title: Preview Url
claim_url:
type: string
title: Claim Url
claim_code:
type: string
title: Claim Code
token:
type: string
title: Token
expires_at:
type: string
title: Expires At
type: object
required:
- project_id
- slug
- organization
- url
- preview_url
- claim_url
- claim_code
- token
- expires_at
title: ClaimableCreateOut
ClaimablePreviewOut:
properties:
url:
type: string
title: Url
expires_at:
type: string
title: Expires At
type: object
required:
- url
- expires_at
title: ClaimablePreviewOut
ProjectPresetOut:
properties:
name:
type: string
title: Name
label:
type: string
title: Label
fields:
items:
type: string
type: array
title: Fields
defaults:
additionalProperties:
anyOf:
- type: string
- type: 'null'
type: object
title: Defaults
default: {}
sources:
additionalProperties:
type: string
type: object
title: Sources
default: {}
start_candidates:
items:
type: string
type: array
title: Start Candidates
default: []
policy:
additionalProperties:
type: string
type: object
title: Policy
default: {}
has_ssr_switch:
type: boolean
title: Has Ssr Switch
default: false
env_prefix:
anyOf:
- type: string
- type: 'null'
title: Env Prefix
type: object
required:
- name
- label
- fields
title: ProjectPresetOut
description: 'Договор фреймворка о сборке — в том виде, в каком его читает панель.
Считается из `detection.spec.json` (`services/presets.py`), поэтому вторая
рукописная таблица умолчаний в панели становится не нужна.'
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
input:
title: Input
ctx:
type: object
title: Context
type: object
required:
- loc
- msg
- type
title: ValidationError
ClaimableCreateIn:
properties:
name:
anyOf:
- type: string
maxLength: 60
minLength: 1
- type: 'null'
title: Name
framework_hint:
anyOf:
- type: string
maxLength: 32
- type: 'null'
title: Framework Hint
channel:
type: string
enum:
- cli
- web
title: Channel
default: cli
captcha_token:
anyOf:
- type: string
maxLength: 4096
- type: 'null'
title: Captcha Token
type: object
title: ClaimableCreateIn
OrganizationInline:
properties:
id:
type: string
format: uuid
title: Id
github_login:
anyOf:
- type: string
- type: 'null'
title: Github Login
slug:
type: string
title: Slug
kind:
type: string
title: Kind
default: team
type: object
required:
- id
- slug
title: OrganizationInline
ClaimIn:
properties:
code:
type: string
maxLength: 200
minLength: 8
title: Code
type: object
required:
- code
title: ClaimIn
ClaimableStatusOut:
properties:
status:
type: string
enum:
- unclaimed
- claimed
- expired
title: Status
slug:
type: string
title: Slug
url:
type: string
title: Url
expires_at:
type: string
title: Expires At
preview_url:
type: string
title: Preview Url
favicon_url:
anyOf:
- type: string
- type: 'null'
title: Favicon Url
type: object
required:
- status
- slug
- url
- expires_at
- preview_url
title: ClaimableStatusOut