لوكلاء AI: ملف markdown لهذه الصفحة — /docs-content-en/infra/providers.md فهرس التوثيق — /llms.txt

مقالات التوثيق متاحة حاليًا باللغة الإنجليزية فقط.

Providers and catalogs

Four reference endpoints that return lists of cloud providers and the plans, regions, and OS images available on them. Call them before creating a server to obtain the correct identifiers for provider, plan, region, image in POST /v1/infra/servers.

List of providers

GET /v1/infra/providers

Returns the list of cloud providers where servers can be created. The available field shows whether the platform has credentials configured for this provider and whether the provider is ready to create new virtual machines (VMs).

Examples

curl — personal key

Terminal 
curl -H "X-Api-Key: YOUR_API_KEY" \
  https://vibecode.bitrix24.com/v1/infra/providers

curl — OAuth application

Terminal 
curl -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  https://vibecode.bitrix24.com/v1/infra/providers

JavaScript — personal key

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/infra/providers', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const { data } = await res.json()
const active = data.filter(p => p.available)
console.log('Available providers:', active.map(p => p.id))

JavaScript — OAuth application

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/infra/providers', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})
const { data } = await res.json()

Response fields

Field Type Description
Fieldsuccess Typeboolean DescriptionAlways true on success
Fielddata Typearray DescriptionArray of providers
Fielddata[].id Typestring DescriptionProvider ID to pass in provider when creating a server (e.g. bitrix-cloud)
Fielddata[].name Typestring DescriptionDisplay name for the user
Fielddata[].available Typeboolean Descriptiontrue if the provider is configured on the platform and ready to create servers. false — creation will fail with a NO_CREDENTIALS error

Response example

JSON 
{
  "success": true,
  "data": [
    {
      "id": "bitrix-cloud",
      "name": "Bitrix24 Cloud",
      "available": true
    }
  ]
}

Error response example

401 — API key not provided:

JSON 
{
  "success": false,
  "error": {
    "code": "MISSING_API_KEY",
    "message": "API key required. Pass via X-Api-Key header."
  }
}

Errors

HTTP Code Description
HTTP401 CodeMISSING_API_KEY DescriptionThe X-Api-Key header was not provided
HTTP401 CodeINVALID_API_KEY DescriptionThe key is not recognized — no such key exists on the platform
HTTP429 CodeRATE_LIMITED DescriptionThe platform's overall request limit was exceeded

Full list of common API errors — Errors.

Known specifics

  • The response is not paginated — the list is small and returned in full.

See also