API-Referenz
Die folgende API-Dokumentation wird aus dem Endpoint-Katalog der Portal API des Cloud Services Portals generiert. Sie umfasst alle Endpunkte, gruppiert nach Funktionsbereich. Bei jedem Endpunkt ist die Permission angegeben, die für den Aufruf benötigt wird.
Authentifizierung
Jede Anfrage an die Portal API muss mit einem Access-Token authentifiziert werden. Das Access-Token erstellen Sie selbst im Cloud Services Portal und weisen ihm die entsprechenden Berechtigungen zu (siehe unten). Optional lässt sich ein Start- und Enddatum setzen, um die Gültigkeit des Tokens einzuschränken.
Das Access-Token wird bei jeder Anfrage im auth-token-Header übergeben. Zusätzlich enthält jede Anfrage den region-Header, der die Region angibt (z. B. ch-zh1).
Die von einem Endpunkt benötigte Permission ist in der API-Dokumentation unten jeweils aufgeführt.
Beispielanfrage:
curl --url 'https://api.openmgmt.safeswisscloud.ch/openstack/availability_zones' \
-H 'region: ch-zh1' \
-H 'auth-token: <access-token>'
Access-Token erstellen
Navigieren Sie im linken Menü zu User → API Keys (1), wechseln Sie auf den Tab Access Tokens (2) und klicken Sie auf + Create Token (3).
Im Dialog Create token vergeben Sie einen Namen (1) und setzen optional ein Start- und End-Datum zur Begrenzung der Gültigkeit (2). Klicken Sie anschliessend auf Create (3). Das generierte Access-Token wird angezeigt (4) — kopieren Sie es über Copy Token und speichern Sie es sicher ab: Das Token wird nicht gespeichert und kann nach dem Schliessen des Fensters nicht mehr abgerufen werden (5).
Zum Schluss weisen Sie die Berechtigungen zu: Klappen Sie die Zeile des Tokens über das >-Symbol auf (1) und aktivieren Sie die benötigten Permissions über die Schalter (2, 3). Mit Enable all und Disable all schalten Sie alle Permissions auf einmal ein bzw. aus.
Portal API
Portal API of the Cloud Services Portal. All endpoints require authentication against the portal; the required permission is listed on each operation.
Servers
| Description | URL |
|---|---|
| Base URL of the Portal API (ssc). | https://api.openmgmt.safeswisscloud.ch |
AI
GET /ai/cost/all
List AI All costs
Description
List AI All costs
Required permission: ai_all_costs-get
Responses
{
"cache_creation_input_audio_token_cost": 10.12,
"cache_creation_input_token_cost": 10.12,
"cache_creation_input_token_cost_above_200k_tokens": 10.12,
"cache_read_input_image_token_cost": 10.12,
"cache_read_input_token_cost": 10.12,
"cache_read_input_token_cost_above_200k_tokens": 10.12,
"cache_read_input_token_cost_above_200k_tokens_priority": 10.12,
"cache_read_input_token_cost_above_272k_tokens": 10.12,
"cache_read_input_token_cost_above_272k_tokens_priority": 10.12,
"cache_read_input_token_cost_flex": 10.12,
"cache_read_input_token_cost_priority": 10.12,
"code_interpreter_cost_per_session": 10.12,
"input_cost_per_audio_per_second": 10.12,
"input_cost_per_audio_per_second_above_128k_tokens": 10.12,
"input_cost_per_audio_token": 10.12,
"input_cost_per_character": 10.12,
"input_cost_per_image": 10.12,
"input_cost_per_image_token": 10.12,
"input_cost_per_pixel": 10.12,
"input_cost_per_second": 10.12,
"input_cost_per_token": 10.12,
"input_cost_per_token_above_128k_tokens": 10.12,
"input_cost_per_token_above_200k_tokens": 10.12,
"input_cost_per_token_above_200k_tokens_priority": 10.12,
"input_cost_per_token_above_272k_tokens": 10.12,
"input_cost_per_token_above_272k_tokens_priority": 10.12,
"input_cost_per_token_batches": 10.12,
"input_cost_per_token_flex": 10.12,
"input_cost_per_token_priority": 10.12,
"input_cost_per_video_per_second": 10.12,
"input_cost_per_video_per_second_above_128k_tokens": 10.12,
"output_cost_per_audio_token": 10.12,
"output_cost_per_image": 10.12,
"output_cost_per_image_above_1024_and_1024_pixels": 10.12,
"output_cost_per_image_above_2048_and_2048_pixels": 10.12,
"output_cost_per_image_above_4096_and_4096_pixels": 10.12,
"output_cost_per_image_above_512_and_512_pixels": 10.12,
"output_cost_per_image_auto_quality": 10.12,
"output_cost_per_image_high_quality": 10.12,
"output_cost_per_image_low_quality": 10.12,
"output_cost_per_image_medium_quality": 10.12,
"output_cost_per_image_token": 10.12,
"output_cost_per_pixel": 10.12,
"output_cost_per_second": 10.12,
"output_cost_per_token": 10.12,
"output_cost_per_token_above_128k_tokens": 10.12,
"output_cost_per_token_above_200k_tokens": 10.12,
"output_cost_per_token_above_200k_tokens_priority": 10.12,
"output_cost_per_token_above_272k_tokens": 10.12,
"output_cost_per_token_above_272k_tokens_priority": 10.12,
"output_cost_per_token_batches": 10.12,
"output_cost_per_token_flex": 10.12,
"output_cost_per_token_priority": 10.12,
"output_cost_per_video_per_second": 10.12,
"search_context_cost_per_query": 10.12
}
Schema of the response body
{
"type": "object",
"properties": {
"cache_creation_input_audio_token_cost": {
"type": "number"
},
"cache_creation_input_token_cost": {
"type": "number"
},
"cache_creation_input_token_cost_above_200k_tokens": {
"type": "number"
},
"cache_read_input_image_token_cost": {
"type": "number"
},
"cache_read_input_token_cost": {
"type": "number"
},
"cache_read_input_token_cost_above_200k_tokens": {
"type": "number"
},
"cache_read_input_token_cost_above_200k_tokens_priority": {
"type": "number"
},
"cache_read_input_token_cost_above_272k_tokens": {
"type": "number"
},
"cache_read_input_token_cost_above_272k_tokens_priority": {
"type": "number"
},
"cache_read_input_token_cost_flex": {
"type": "number"
},
"cache_read_input_token_cost_priority": {
"type": "number"
},
"code_interpreter_cost_per_session": {
"type": "number"
},
"input_cost_per_audio_per_second": {
"type": "number"
},
"input_cost_per_audio_per_second_above_128k_tokens": {
"type": "number"
},
"input_cost_per_audio_token": {
"type": "number"
},
"input_cost_per_character": {
"type": "number"
},
"input_cost_per_image": {
"type": "number"
},
"input_cost_per_image_token": {
"type": "number"
},
"input_cost_per_pixel": {
"type": "number"
},
"input_cost_per_second": {
"type": "number"
},
"input_cost_per_token": {
"type": "number"
},
"input_cost_per_token_above_128k_tokens": {
"type": "number"
},
"input_cost_per_token_above_200k_tokens": {
"type": "number"
},
"input_cost_per_token_above_200k_tokens_priority": {
"type": "number"
},
"input_cost_per_token_above_272k_tokens": {
"type": "number"
},
"input_cost_per_token_above_272k_tokens_priority": {
"type": "number"
},
"input_cost_per_token_batches": {
"type": "number"
},
"input_cost_per_token_flex": {
"type": "number"
},
"input_cost_per_token_priority": {
"type": "number"
},
"input_cost_per_video_per_second": {
"type": "number"
},
"input_cost_per_video_per_second_above_128k_tokens": {
"type": "number"
},
"output_cost_per_audio_token": {
"type": "number"
},
"output_cost_per_image": {
"type": "number"
},
"output_cost_per_image_above_1024_and_1024_pixels": {
"type": "number"
},
"output_cost_per_image_above_2048_and_2048_pixels": {
"type": "number"
},
"output_cost_per_image_above_4096_and_4096_pixels": {
"type": "number"
},
"output_cost_per_image_above_512_and_512_pixels": {
"type": "number"
},
"output_cost_per_image_auto_quality": {
"type": "number"
},
"output_cost_per_image_high_quality": {
"type": "number"
},
"output_cost_per_image_low_quality": {
"type": "number"
},
"output_cost_per_image_medium_quality": {
"type": "number"
},
"output_cost_per_image_token": {
"type": "number"
},
"output_cost_per_pixel": {
"type": "number"
},
"output_cost_per_second": {
"type": "number"
},
"output_cost_per_token": {
"type": "number"
},
"output_cost_per_token_above_128k_tokens": {
"type": "number"
},
"output_cost_per_token_above_200k_tokens": {
"type": "number"
},
"output_cost_per_token_above_200k_tokens_priority": {
"type": "number"
},
"output_cost_per_token_above_272k_tokens": {
"type": "number"
},
"output_cost_per_token_above_272k_tokens_priority": {
"type": "number"
},
"output_cost_per_token_batches": {
"type": "number"
},
"output_cost_per_token_flex": {
"type": "number"
},
"output_cost_per_token_priority": {
"type": "number"
},
"output_cost_per_video_per_second": {
"type": "number"
},
"search_context_cost_per_query": {
"type": "number"
}
}
}
GET /ai/customer
Get AI Customer
Description
Get AI Customer
Required permission: ai_customer-get
Responses
[
{
"budgets": [],
"id": "string",
"llms": {},
"name": "string",
"profile": {},
"rate_limits": [],
"teams": []
}
]
Schema of the response body
{
"type": "array",
"items": {
"type": "object",
"properties": {
"budgets": {
"type": "array"
},
"id": {
"type": "string"
},
"llms": {
"type": "object",
"additionalProperties": true
},
"name": {
"type": "string"
},
"profile": {
"type": "object",
"additionalProperties": true
},
"rate_limits": {
"type": "array"
},
"teams": {
"type": "array"
}
}
}
}
GET /ai/keys
List AI Keys
Description
List AI Keys
Required permission: ai-get
Request body
{
"ai_project_id": "string",
"end": "string",
"start": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"ai_project_id": {
"type": "string"
},
"end": {
"type": "string"
},
"start": {
"type": "string"
}
}
}
Responses
[
{
"budgets": [],
"customer": {},
"description": "string",
"id": "string",
"is_active": true,
"is_limited": true,
"name": "string",
"original_name": "string",
"parent_profile": {},
"profile": {},
"project": "string",
"project_id": "string",
"provider_configs": [],
"rate_limits": [],
"team": {},
"tokens_usage": {},
"uplift": [],
"user": "string",
"user_id": "string",
"verified": {}
}
]
Schema of the response body
{
"type": "array",
"items": {
"type": "object",
"properties": {
"budgets": {
"type": "array"
},
"customer": {
"type": "object",
"additionalProperties": true
},
"description": {
"type": "string"
},
"id": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"is_limited": {
"type": "boolean"
},
"name": {
"type": "string"
},
"original_name": {
"type": "string"
},
"parent_profile": {
"type": "object",
"additionalProperties": true
},
"profile": {
"type": "object",
"additionalProperties": true
},
"project": {
"type": "string"
},
"project_id": {
"type": "string"
},
"provider_configs": {
"type": "array"
},
"rate_limits": {
"type": "array"
},
"team": {
"type": "object",
"additionalProperties": true
},
"tokens_usage": {
"type": "object",
"additionalProperties": true
},
"uplift": {
"type": "array"
},
"user": {
"type": "string"
},
"user_id": {
"type": "string"
},
"verified": {
"type": "object",
"additionalProperties": true
}
}
}
}
POST /ai/keys
Create AI Key
Description
Create AI Key
Required permission: ai-post
Request body
{
"description": "string",
"name": "string",
"tier": "string",
"user_bound": "string",
"project_id": "string",
"user": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"description": {
"type": "string"
},
"name": {
"type": "string"
},
"tier": {
"type": "string"
},
"user_bound": {
"type": "string"
},
"project_id": {
"type": "string"
},
"user": {
"type": "string"
}
},
"required": [
"description",
"name",
"tier",
"user_bound"
]
}
Responses
{
"budgets": [],
"description": "string",
"id": "string",
"is_active": true,
"name": "string",
"provider_configs": [],
"rate_limits": []
}
Schema of the response body
{
"type": "object",
"properties": {
"budgets": {
"type": "array"
},
"description": {
"type": "string"
},
"id": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"name": {
"type": "string"
},
"provider_configs": {
"type": "array"
},
"rate_limits": {
"type": "array"
}
}
}
DELETE /ai/keys/{key_id}
Delete AI Key
Description
Delete AI Key
Required permission: ai_key-delete
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
key_id |
path | string | No |
Responses
GET /ai/keys/{key_id}
Get AI Key
Description
Get AI Key
Required permission: ai_key-get
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
key_id |
path | string | No |
Responses
{
"budgets": [],
"customer": {},
"description": "string",
"id": "string",
"is_active": true,
"model_limits": [],
"name": "string",
"provider_configs": [],
"rate_limits": [],
"team": {}
}
Schema of the response body
{
"type": "object",
"properties": {
"budgets": {
"type": "array"
},
"customer": {
"type": "object",
"additionalProperties": true
},
"description": {
"type": "string"
},
"id": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"model_limits": {
"type": "array"
},
"name": {
"type": "string"
},
"provider_configs": {
"type": "array"
},
"rate_limits": {
"type": "array"
},
"team": {
"type": "object",
"additionalProperties": true
}
}
}
PATCH /ai/keys/{key_id}
Update AI Key
Description
Update AI Key
Required permission: ai_key-patch
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
key_id |
path | string | No |
Request body
{
"active": "string",
"budgets": "string",
"description": "string",
"llms": "string",
"name": "string",
"rate_limits": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"active": {
"type": "string"
},
"budgets": {
"type": "string"
},
"description": {
"type": "string"
},
"llms": {
"type": "string"
},
"name": {
"type": "string"
},
"rate_limits": {
"type": "string"
}
}
}
Responses
{
"budgets": [],
"description": "string",
"id": "string",
"is_active": true,
"name": "string",
"provider_configs": [],
"rate_limits": []
}
Schema of the response body
{
"type": "object",
"properties": {
"budgets": {
"type": "array"
},
"description": {
"type": "string"
},
"id": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"name": {
"type": "string"
},
"provider_configs": {
"type": "array"
},
"rate_limits": {
"type": "array"
}
}
}
PATCH /ai/keys/{key_id}/assignments
Set AI Key Assignments
Description
Set AI Key Assignments
Required permission: ai_key_assignments-patch
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
key_id |
path | string | No |
Request body
{
"project_id": "string",
"user_id": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"project_id": {
"type": "string"
},
"user_id": {
"type": "string"
}
}
}
Responses
GET /ai/keys/{key_id}/cost
Get AI Key Cost
Description
Get AI Key Cost
Required permission: ai_key_cost-get
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
key_id |
path | string | No |
Request body
{
"end": "string",
"start": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"end": {
"type": "string"
},
"start": {
"type": "string"
}
}
}
Responses
{
"from": "string",
"key_price": 0,
"price": 10.12,
"to": "string",
"tokens": 0,
"usage": {}
}
Schema of the response body
{
"type": "object",
"properties": {
"from": {
"type": "string"
},
"key_price": {
"type": "integer"
},
"price": {
"type": "number"
},
"to": {
"type": "string"
},
"tokens": {
"type": "integer"
},
"usage": {
"type": "object",
"additionalProperties": true
}
}
}
GET /ai/models
List AI Models
Description
List AI Models
Required permission: ai_models-get
Request body
{
"list_all": "string",
"project": "string",
"providers": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"list_all": {
"type": "string"
},
"project": {
"type": "string"
},
"providers": {
"type": "string"
}
}
}
Responses
{
"all_available": true,
"llms": []
}
Schema of the response body
{
"type": "object",
"properties": {
"all_available": {
"type": "boolean"
},
"llms": {
"type": "array"
}
}
}
DELETE /ai/project/{ai_project_id}
Delete AI Project
Description
Delete AI Project
Required permission: ai_team_management-delete
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ai_project_id |
path | string | No |
Responses
GET /ai/project/{ai_project_id}
Get AI Project
Description
Get AI Project
Required permission: ai_team_management-get
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ai_project_id |
path | string | No |
Responses
[
{
"budgets": [],
"client_id": "string",
"customer": {},
"description": "string",
"disabled": true,
"id": "string",
"keys": [],
"llms": {},
"name": "string",
"original_name": "string",
"rate_limits": [],
"reseller": "string",
"tokens_usage": {}
}
]
Schema of the response body
{
"type": "array",
"items": {
"type": "object",
"properties": {
"budgets": {
"type": "array"
},
"client_id": {
"type": "string"
},
"customer": {
"type": "object",
"additionalProperties": true
},
"description": {
"type": "string"
},
"disabled": {
"type": "boolean"
},
"id": {
"type": "string"
},
"keys": {
"type": "array"
},
"llms": {
"type": "object",
"additionalProperties": true
},
"name": {
"type": "string"
},
"original_name": {
"type": "string"
},
"rate_limits": {
"type": "array"
},
"reseller": {
"type": "string"
},
"tokens_usage": {
"type": "object",
"additionalProperties": true
}
}
}
}
PATCH /ai/project/{ai_project_id}
Update AI Project
Description
Update AI Project
Required permission: ai_team_management-patch
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ai_project_id |
path | string | No |
Request body
{
"apply_keys": "string",
"budgets": "string",
"description": "string",
"llms": "string",
"name": "string",
"rate_limits": "string",
"remove": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"apply_keys": {
"type": "string"
},
"budgets": {
"type": "string"
},
"description": {
"type": "string"
},
"llms": {
"type": "string"
},
"name": {
"type": "string"
},
"rate_limits": {
"type": "string"
},
"remove": {
"type": "string"
}
}
}
Responses
GET /ai/project/{ai_project_id}/cost
Get AI Project cost
Description
Get AI Project cost
Required permission: ai_team_management_cost-get
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ai_project_id |
path | string | No |
Request body
{
"end": "string",
"start": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"end": {
"type": "string"
},
"start": {
"type": "string"
}
}
}
Responses
{
"from": "string",
"price": 10.12,
"to": "string",
"tokens": 0,
"usage": {}
}
Schema of the response body
{
"type": "object",
"properties": {
"from": {
"type": "string"
},
"price": {
"type": "number"
},
"to": {
"type": "string"
},
"tokens": {
"type": "integer"
},
"usage": {
"type": "object",
"additionalProperties": true
}
}
}
PATCH /ai/project/{ai_project_id}/toggle
Toggle AI Project (Enable/Disable)
Description
Toggle AI Project (Enable/Disable)
Required permission: ai_team_management_toggle-patch
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ai_project_id |
path | string | No |
Responses
DELETE /ai/project/{ai_project_id}/users
Remove users from AI Project
Description
Remove users from AI Project
Required permission: ai_team_users_management-delete
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ai_project_id |
path | string | No |
Request body
{
"users_ids": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"users_ids": {
"type": "string"
}
},
"required": [
"users_ids"
]
}
Responses
GET /ai/project/{ai_project_id}/users
List users in AI Project
Description
List users in AI Project
Required permission: ai_team_users_management-get
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ai_project_id |
path | string | No |
Responses
[
{
"client": "string",
"client_id": "string",
"email": "string",
"enabled": "string",
"firstName": "string",
"id": "string",
"lastName": "string",
"reseller": "string",
"username": "string"
}
]
Schema of the response body
{
"type": "array",
"items": {
"type": "object",
"properties": {
"client": {
"type": "string"
},
"client_id": {
"type": "string"
},
"email": {
"type": "string"
},
"enabled": {
"type": "string"
},
"firstName": {
"type": "string"
},
"id": {
"type": "string"
},
"lastName": {
"type": "string"
},
"reseller": {
"type": "string"
},
"username": {
"type": "string"
}
}
}
}
POST /ai/project/{ai_project_id}/users
Add users to AI Project
Description
Add users to AI Project
Required permission: ai_team_users_management-post
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
ai_project_id |
path | string | No |
Request body
{
"users_ids": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"users_ids": {
"type": "string"
}
},
"required": [
"users_ids"
]
}
Responses
GET /ai/projects
List AI Projects
Description
List AI Projects
Required permission: ai_teams_management-get
Responses
[
{
"budgets": [],
"client_id": "string",
"customer": {},
"description": "string",
"disabled": true,
"id": "string",
"keys": [],
"llm": [],
"name": "string",
"original_name": "string",
"rate_limits": [],
"reseller": "string",
"tokens_usage": {}
}
]
Schema of the response body
{
"type": "array",
"items": {
"type": "object",
"properties": {
"budgets": {
"type": "array"
},
"client_id": {
"type": "string"
},
"customer": {
"type": "object",
"additionalProperties": true
},
"description": {
"type": "string"
},
"disabled": {
"type": "boolean"
},
"id": {
"type": "string"
},
"keys": {
"type": "array"
},
"llm": {
"type": "array"
},
"name": {
"type": "string"
},
"original_name": {
"type": "string"
},
"rate_limits": {
"type": "array"
},
"reseller": {
"type": "string"
},
"tokens_usage": {
"type": "object",
"additionalProperties": true
}
}
}
}
POST /ai/projects
Create AI Project
Description
Create AI Project
Required permission: ai_teams_management-post
Request body
{
"description": "string",
"name": "string",
"tier": "string",
"apply_keys": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"description": {
"type": "string"
},
"name": {
"type": "string"
},
"tier": {
"type": "string"
},
"apply_keys": {
"type": "string"
}
},
"required": [
"description",
"name",
"tier"
]
}
Responses
[
{
"budgets": [],
"customer_id": "string",
"description": "string",
"id": "string",
"llm": [],
"name": "string",
"rate_limits": []
}
]
Schema of the response body
{
"type": "array",
"items": {
"type": "object",
"properties": {
"budgets": {
"type": "array"
},
"customer_id": {
"type": "string"
},
"description": {
"type": "string"
},
"id": {
"type": "string"
},
"llm": {
"type": "array"
},
"name": {
"type": "string"
},
"rate_limits": {
"type": "array"
}
}
}
}
GET /ai/providers
List AI Providers
Description
List AI Providers
Required permission: ai_providers-get
Responses
{
"all_available": true,
"providers": []
}
Schema of the response body
{
"type": "object",
"properties": {
"all_available": {
"type": "boolean"
},
"providers": {
"type": "array"
}
}
}
Backups
POST /backup
Create backup
Description
Create backup
Required permission: create_backup-post
Request body
{
"policy_id": "string",
"resource_id": "string",
"resource_type": "string",
"starting_hour": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"policy_id": {
"type": "string"
},
"resource_id": {
"type": "string"
},
"resource_type": {
"type": "string"
},
"starting_hour": {
"type": "string"
}
},
"required": [
"policy_id",
"resource_id",
"resource_type",
"starting_hour"
]
}
Responses
GET /backup/{backup_id}
Get backup by id
Description
Get backup by id
Required permission: backup-get
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
backup_id |
path | string | No |
Responses
{
"allocated": 10.12,
"canceled_by": "string",
"id": "string",
"image": "string",
"is_available": true,
"is_full": true,
"last_restore": "string",
"manual": true,
"message": "string",
"pool": "string",
"primary_zone": "string",
"process_time": 0,
"processed_date": "string",
"protected_resource_id": "string",
"region": "string",
"resource_id": "string",
"resource_type": "string",
"restore_size": 0,
"retries": 0,
"schedule_date": "string",
"secondary_zone": "string",
"size": 10.12,
"snapshot": "string",
"state": "string",
"time_to_live": "string",
"volume_type": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"allocated": {
"type": "number"
},
"canceled_by": {
"type": "string"
},
"id": {
"type": "string"
},
"image": {
"type": "string"
},
"is_available": {
"type": "boolean"
},
"is_full": {
"type": "boolean"
},
"last_restore": {
"type": "string"
},
"manual": {
"type": "boolean"
},
"message": {
"type": "string"
},
"pool": {
"type": "string"
},
"primary_zone": {
"type": "string"
},
"process_time": {
"type": "integer"
},
"processed_date": {
"type": "string"
},
"protected_resource_id": {
"type": "string"
},
"region": {
"type": "string"
},
"resource_id": {
"type": "string"
},
"resource_type": {
"type": "string"
},
"restore_size": {
"type": "integer"
},
"retries": {
"type": "integer"
},
"schedule_date": {
"type": "string"
},
"secondary_zone": {
"type": "string"
},
"size": {
"type": "number"
},
"snapshot": {
"type": "string"
},
"state": {
"type": "string"
},
"time_to_live": {
"type": "string"
},
"volume_type": {
"type": "string"
}
}
}
PATCH /backup/{backup_id}/cancel
Cancel backup
Description
Cancel backup
Required permission: cancel_backup-patch
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
backup_id |
path | string | No |
Responses
PATCH /backup/{backup_id}/extend
Increase backup lifetime
Description
Increase backup lifetime
Required permission: extend_backup_time-patch
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
backup_id |
path | string | No |
Request body
{
"ttl": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"ttl": {
"type": "string"
}
},
"required": [
"ttl"
]
}
Responses
POST /backup/{backup_id}/force_start
Force backup to run
Description
Force backup to run
Required permission: force_backup_start-post
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
backup_id |
path | string | No |
Responses
DELETE /backup/{backup_id}/unassign/{policy_id}
Unassign backup policy from resource
Description
Unassign backup policy from resource
Required permission: unassign_backup_policy-delete
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
backup_id |
path | string | No | ||
policy_id |
path | string | No |
Request body
{
"reason": "string",
"resource_id": "string",
"ttl": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"reason": {
"type": "string"
},
"resource_id": {
"type": "string"
},
"ttl": {
"type": "string"
}
},
"required": [
"reason",
"resource_id",
"ttl"
]
}
Responses
GET /backup/policies
List backup policies
Description
List backup policies
Required permission: backup_policies-get
Request body
{
"show_all": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"show_all": {
"type": "string"
}
}
}
Responses
[
{
"avatar": "string",
"backup_backend_rule": "string",
"backup_strictness": "string",
"backup_window": 0,
"created_at": "string",
"created_by": "string",
"description": "string",
"disabled_at": "string",
"disabled_by": "string",
"id": "string",
"increment_policy": 0,
"name": "string",
"notification_email": "string",
"retention_primary": 0,
"retention_secondary": 0,
"retry": 0,
"schedule": "string"
}
]
Schema of the response body
{
"type": "array",
"items": {
"type": "object",
"properties": {
"avatar": {
"type": "string"
},
"backup_backend_rule": {
"type": "string"
},
"backup_strictness": {
"type": "string"
},
"backup_window": {
"type": "integer"
},
"created_at": {
"type": "string"
},
"created_by": {
"type": "string"
},
"description": {
"type": "string"
},
"disabled_at": {
"type": "string"
},
"disabled_by": {
"type": "string"
},
"id": {
"type": "string"
},
"increment_policy": {
"type": "integer"
},
"name": {
"type": "string"
},
"notification_email": {
"type": "string"
},
"retention_primary": {
"type": "integer"
},
"retention_secondary": {
"type": "integer"
},
"retry": {
"type": "integer"
},
"schedule": {
"type": "string"
}
}
}
}
GET /backup/resource/project/{project_id}/details
Get backup project details
Description
Get backup project details
Required permission: backup_project-get
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
project_id |
path | string | No |
Responses
{
"allow_remove": true,
"description": "string",
"domain_id": "string",
"enabled": true,
"id": "string",
"is_domain": true,
"links": {},
"name": "string",
"options": {},
"parent_id": "string",
"policy": "string",
"protected_resource_id": "string",
"relaxed": true,
"resource_policies": [],
"tags": [],
"unsafe_resources": [],
"unsafe_vms": 0,
"unsafe_volumes": 0
}
Schema of the response body
{
"type": "object",
"properties": {
"allow_remove": {
"type": "boolean"
},
"description": {
"type": "string"
},
"domain_id": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"id": {
"type": "string"
},
"is_domain": {
"type": "boolean"
},
"links": {
"type": "object",
"additionalProperties": true
},
"name": {
"type": "string"
},
"options": {
"type": "object",
"additionalProperties": true
},
"parent_id": {
"type": "string"
},
"policy": {
"type": "string"
},
"protected_resource_id": {
"type": "string"
},
"relaxed": {
"type": "boolean"
},
"resource_policies": {
"type": "array"
},
"tags": {
"type": "array"
},
"unsafe_resources": {
"type": "array"
},
"unsafe_vms": {
"type": "integer"
},
"unsafe_volumes": {
"type": "integer"
}
}
}
GET /backup/resource/project/{project_id}/vm/{vm_id}/details
Get backup vm details
Description
Get backup vm details
Required permission: backup_vm-get
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
project_id |
path | string | No | ||
vm_id |
path | string | No |
Responses
{
"addresses": {},
"allow_remove": true,
"client": "string",
"created": "string",
"flavor": {},
"host_id": "string",
"id": "string",
"image": {},
"key_name": "string",
"metadata": {},
"name": "string",
"policy": "string",
"project_id": "string",
"project_name": "string",
"protected_resource_id": "string",
"relaxed": true,
"reseller": "string",
"resource_policies": [],
"status": "string",
"unsafe_volumes": 0,
"updated": "string",
"user_id": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"addresses": {
"type": "object",
"additionalProperties": true
},
"allow_remove": {
"type": "boolean"
},
"client": {
"type": "string"
},
"created": {
"type": "string"
},
"flavor": {
"type": "object",
"additionalProperties": true
},
"host_id": {
"type": "string"
},
"id": {
"type": "string"
},
"image": {
"type": "object",
"additionalProperties": true
},
"key_name": {
"type": "string"
},
"metadata": {
"type": "object",
"additionalProperties": true
},
"name": {
"type": "string"
},
"policy": {
"type": "string"
},
"project_id": {
"type": "string"
},
"project_name": {
"type": "string"
},
"protected_resource_id": {
"type": "string"
},
"relaxed": {
"type": "boolean"
},
"reseller": {
"type": "string"
},
"resource_policies": {
"type": "array"
},
"status": {
"type": "string"
},
"unsafe_volumes": {
"type": "integer"
},
"updated": {
"type": "string"
},
"user_id": {
"type": "string"
}
}
}
GET /backup/resource/project/{project_id}/vm/{vm_id}/volumes
List backup VM volumes
Description
List backup VM volumes
Required permission: backup_vm_volumes-get
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
project_id |
path | string | No | ||
vm_id |
path | string | No |
Request body
{
"get_all": "string",
"simple": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"get_all": {
"type": "string"
},
"simple": {
"type": "string"
}
}
}
Responses
[
{
"allow_remove": true,
"attachments": [],
"device": "string",
"id": "string",
"name": "string",
"policies": {},
"policy": "string",
"project_id": "string",
"protected_resources": [],
"resource_policies": [],
"size": 0,
"type": "string"
}
]
Schema of the response body
{
"type": "array",
"items": {
"type": "object",
"properties": {
"allow_remove": {
"type": "boolean"
},
"attachments": {
"type": "array"
},
"device": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"policies": {
"type": "object",
"additionalProperties": true
},
"policy": {
"type": "string"
},
"project_id": {
"type": "string"
},
"protected_resources": {
"type": "array"
},
"resource_policies": {
"type": "array"
},
"size": {
"type": "integer"
},
"type": {
"type": "string"
}
}
}
}
GET /backup/resource/project/{project_id}/vms
List backup VMs
Description
List backup VMs
Required permission: backup_vms-get
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
project_id |
path | string | No |
Request body
{
"get_all": "string",
"simple": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"get_all": {
"type": "string"
},
"simple": {
"type": "string"
}
}
}
Responses
[
{
"addresses": {},
"allow_remove": true,
"client": "string",
"created": "string",
"flavor": {},
"host_id": "string",
"id": "string",
"image": {},
"key_name": "string",
"metadata": {},
"name": "string",
"policies": {},
"policy": "string",
"project_id": "string",
"project_name": "string",
"protected_resources": [],
"reseller": "string",
"resource_policies": [],
"status": "string",
"unsafe_volumes": 0,
"updated": "string",
"user_id": "string"
}
]
Schema of the response body
{
"type": "array",
"items": {
"type": "object",
"properties": {
"addresses": {
"type": "object",
"additionalProperties": true
},
"allow_remove": {
"type": "boolean"
},
"client": {
"type": "string"
},
"created": {
"type": "string"
},
"flavor": {
"type": "object",
"additionalProperties": true
},
"host_id": {
"type": "string"
},
"id": {
"type": "string"
},
"image": {
"type": "object",
"additionalProperties": true
},
"key_name": {
"type": "string"
},
"metadata": {
"type": "object",
"additionalProperties": true
},
"name": {
"type": "string"
},
"policies": {
"type": "object",
"additionalProperties": true
},
"policy": {
"type": "string"
},
"project_id": {
"type": "string"
},
"project_name": {
"type": "string"
},
"protected_resources": {
"type": "array"
},
"reseller": {
"type": "string"
},
"resource_policies": {
"type": "array"
},
"status": {
"type": "string"
},
"unsafe_volumes": {
"type": "integer"
},
"updated": {
"type": "string"
},
"user_id": {
"type": "string"
}
}
}
}
GET /backup/resource/project/{project_id}/volume/{volume_id}/details
Get backup volume details
Description
Get backup volume details
Required permission: backup_volume-get
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
project_id |
path | string | No | ||
volume_id |
path | string | No |
Responses
{
"allow_remove": true,
"attachments": [],
"device": "string",
"id": "string",
"name": "string",
"policy": "string",
"project_id": "string",
"protected_resource_id": "string",
"relaxed": true,
"resource_policies": [],
"size": 0,
"type": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"allow_remove": {
"type": "boolean"
},
"attachments": {
"type": "array"
},
"device": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"policy": {
"type": "string"
},
"project_id": {
"type": "string"
},
"protected_resource_id": {
"type": "string"
},
"relaxed": {
"type": "boolean"
},
"resource_policies": {
"type": "array"
},
"size": {
"type": "integer"
},
"type": {
"type": "string"
}
}
}
GET /backup/resource/projects
List backup projects
Description
List backup projects
Required permission: backup_projects-get
Request body
{
"get_all": "string",
"simple": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"get_all": {
"type": "string"
},
"simple": {
"type": "string"
}
}
}
Responses
[
{
"allow_remove": true,
"description": "string",
"domain_id": "string",
"enabled": true,
"id": "string",
"is_domain": true,
"links": {},
"name": "string",
"options": {},
"parent_id": "string",
"policies": {},
"policy": "string",
"protected_resources": [],
"resource_policies": [],
"tags": [],
"unsafe_resources": [],
"unsafe_vms": 0,
"unsafe_volumes": 0
}
]
Schema of the response body
{
"type": "array",
"items": {
"type": "object",
"properties": {
"allow_remove": {
"type": "boolean"
},
"description": {
"type": "string"
},
"domain_id": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"id": {
"type": "string"
},
"is_domain": {
"type": "boolean"
},
"links": {
"type": "object",
"additionalProperties": true
},
"name": {
"type": "string"
},
"options": {
"type": "object",
"additionalProperties": true
},
"parent_id": {
"type": "string"
},
"policies": {
"type": "object",
"additionalProperties": true
},
"policy": {
"type": "string"
},
"protected_resources": {
"type": "array"
},
"resource_policies": {
"type": "array"
},
"tags": {
"type": "array"
},
"unsafe_resources": {
"type": "array"
},
"unsafe_vms": {
"type": "integer"
},
"unsafe_volumes": {
"type": "integer"
}
}
}
}
GET /backup/resources
List all backup resources
Description
List all backup resources
Required permission: backup_resources-get
Responses
{
"domain": {},
"flavor": {},
"image": {},
"project": {},
"vm": {},
"volume": {}
}
Schema of the response body
{
"type": "object",
"properties": {
"domain": {
"type": "object",
"additionalProperties": true
},
"flavor": {
"type": "object",
"additionalProperties": true
},
"image": {
"type": "object",
"additionalProperties": true
},
"project": {
"type": "object",
"additionalProperties": true
},
"vm": {
"type": "object",
"additionalProperties": true
},
"volume": {
"type": "object",
"additionalProperties": true
}
}
}
GET /backups
List backups
Description
List backups
Required permission: backups-get
Responses
[
{
"allocated": 10.12,
"canceled_at": "string",
"canceled_by": "string",
"encrypted": true,
"id": "string",
"image": "string",
"is_available": true,
"is_full": true,
"last_restore": "string",
"manual": true,
"message": "string",
"policy_id": "string",
"pool": "string",
"primary_zone": "string",
"process_time": 0,
"processed_date": "string",
"project_id": "string",
"protected_resource_id": "string",
"reason": "string",
"region": "string",
"resource_id": "string",
"resource_type": "string",
"restore_size": 0,
"retries": 0,
"schedule_date": "string",
"secondary_zone": "string",
"size": 10.12,
"snapshot": "string",
"starting_hour": "string",
"state": "string",
"time_to_live": "string",
"volume_type": "string",
"zone": "string"
}
]
Schema of the response body
{
"type": "array",
"items": {
"type": "object",
"properties": {
"allocated": {
"type": "number"
},
"canceled_at": {
"type": "string"
},
"canceled_by": {
"type": "string"
},
"encrypted": {
"type": "boolean"
},
"id": {
"type": "string"
},
"image": {
"type": "string"
},
"is_available": {
"type": "boolean"
},
"is_full": {
"type": "boolean"
},
"last_restore": {
"type": "string"
},
"manual": {
"type": "boolean"
},
"message": {
"type": "string"
},
"policy_id": {
"type": "string"
},
"pool": {
"type": "string"
},
"primary_zone": {
"type": "string"
},
"process_time": {
"type": "integer"
},
"processed_date": {
"type": "string"
},
"project_id": {
"type": "string"
},
"protected_resource_id": {
"type": "string"
},
"reason": {
"type": "string"
},
"region": {
"type": "string"
},
"resource_id": {
"type": "string"
},
"resource_type": {
"type": "string"
},
"restore_size": {
"type": "integer"
},
"retries": {
"type": "integer"
},
"schedule_date": {
"type": "string"
},
"secondary_zone": {
"type": "string"
},
"size": {
"type": "number"
},
"snapshot": {
"type": "string"
},
"starting_hour": {
"type": "string"
},
"state": {
"type": "string"
},
"time_to_live": {
"type": "string"
},
"volume_type": {
"type": "string"
},
"zone": {
"type": "string"
}
}
}
}
GET /backups/{resource_id}
List backups for resource
Description
List backups for resource
Required permission: backups_resource-get
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
resource_id |
path | string | No |
Responses
[
{
"allocated": 10.12,
"canceled_at": "string",
"canceled_by": "string",
"encrypted": true,
"id": "string",
"image": "string",
"is_available": true,
"is_full": true,
"last_restore": "string",
"manual": true,
"message": "string",
"policy_id": "string",
"pool": "string",
"primary_zone": "string",
"process_time": 0,
"processed_date": "string",
"project_id": "string",
"protected_resource_id": "string",
"reason": "string",
"region": "string",
"resource_id": "string",
"resource_type": "string",
"restore_size": 0,
"retries": 0,
"schedule_date": "string",
"secondary_zone": "string",
"size": 10.12,
"snapshot": "string",
"starting_hour": "string",
"state": "string",
"time_to_live": "string",
"volume_type": "string",
"zone": "string"
}
]
Schema of the response body
{
"type": "array",
"items": {
"type": "object",
"properties": {
"allocated": {
"type": "number"
},
"canceled_at": {
"type": "string"
},
"canceled_by": {
"type": "string"
},
"encrypted": {
"type": "boolean"
},
"id": {
"type": "string"
},
"image": {
"type": "string"
},
"is_available": {
"type": "boolean"
},
"is_full": {
"type": "boolean"
},
"last_restore": {
"type": "string"
},
"manual": {
"type": "boolean"
},
"message": {
"type": "string"
},
"policy_id": {
"type": "string"
},
"pool": {
"type": "string"
},
"primary_zone": {
"type": "string"
},
"process_time": {
"type": "integer"
},
"processed_date": {
"type": "string"
},
"project_id": {
"type": "string"
},
"protected_resource_id": {
"type": "string"
},
"reason": {
"type": "string"
},
"region": {
"type": "string"
},
"resource_id": {
"type": "string"
},
"resource_type": {
"type": "string"
},
"restore_size": {
"type": "integer"
},
"retries": {
"type": "integer"
},
"schedule_date": {
"type": "string"
},
"secondary_zone": {
"type": "string"
},
"size": {
"type": "number"
},
"snapshot": {
"type": "string"
},
"starting_hour": {
"type": "string"
},
"state": {
"type": "string"
},
"time_to_live": {
"type": "string"
},
"volume_type": {
"type": "string"
},
"zone": {
"type": "string"
}
}
}
}
PATCH /backups/refresh_resources
Refresh backup resources
Description
Refresh backup resources
Required permission: backup_refresh-patch
Responses
GET /resources/backups
List resources backups
Description
List resources backups
Required permission: resources_backups-get
Responses
{
"projects": {},
"vms": {},
"volumes": {}
}
Schema of the response body
{
"type": "object",
"properties": {
"projects": {
"type": "object",
"additionalProperties": true
},
"vms": {
"type": "object",
"additionalProperties": true
},
"volumes": {
"type": "object",
"additionalProperties": true
}
}
}
GET /resources/nova_volumes
List nova volumes
Description
List nova volumes
Required permission: resources_nova_volumes-get
Responses
{
"<vm_id>": []
}
Schema of the response body
{
"type": "object",
"properties": {
"<vm_id>": {
"type": "array"
}
}
}
POST /restore/{backup_id}
Restores the backup straight to VM volume
Description
Restores the backup straight to VM volume
Required permission: restore_backup-post
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
backup_id |
path | string | No |
Responses
POST /restore/{backup_id}/image
Restores the backup as a glance image
Description
Restores the backup as a glance image
Required permission: restore_backup_image-post
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
backup_id |
path | string | No |
Request body
{
"volume_name": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"volume_name": {
"type": "string"
}
},
"required": [
"volume_name"
]
}
Responses
POST /restore/{backup_id}/volume
Restores the backup as a new volume
Description
Restores the backup as a new volume
Required permission: restore_backup_volume-post
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
backup_id |
path | string | No |
Request body
{
"availability_zone": "string",
"volume_name": "string",
"volume_type": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"availability_zone": {
"type": "string"
},
"volume_name": {
"type": "string"
},
"volume_type": {
"type": "string"
}
},
"required": [
"availability_zone",
"volume_name",
"volume_type"
]
}
Responses
Context
GET /context
Show all available contexts
Description
Show all available contexts
Required permission: context-get
Responses
{
"<context>": {}
}
Schema of the response body
{
"type": "object",
"properties": {
"<context>": {
"type": "object",
"additionalProperties": true
}
}
}
Dashboards
GET /dashboard/{dashboard_path}
Get dashboard structure
Description
Get dashboard structure
Required permission: dashboard-get
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
dashboard_path |
path | string | No |
Responses
{
"elements": [],
"path_params": {},
"schema": {}
}
Schema of the response body
{
"type": "object",
"properties": {
"elements": {
"type": "array"
},
"path_params": {
"type": "object",
"additionalProperties": true
},
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
GET /dashboard/elements
List elements
Description
List elements
Required permission: elements_get-get
Responses
[
{
"elements": null,
"icon": "string",
"name": "string"
}
]
Schema of the response body
{
"type": "array",
"items": {
"type": "object",
"properties": {
"elements": {},
"icon": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
GET /dashboards
Show all available dashboards
Description
Show all available dashboards
Required permission: dashboards-get
Responses
[
{
"help": "string",
"icon": "string",
"items": [],
"label": "string",
"order": "string"
}
]
Schema of the response body
{
"type": "array",
"items": {
"type": "object",
"properties": {
"help": {
"type": "string"
},
"icon": {
"type": "string"
},
"items": {
"type": "array"
},
"label": {
"type": "string"
},
"order": {
"type": "string"
}
}
}
}
GET /dashboards/all
Get all dashboards
Description
Get all dashboards
Required permission: dashboard_all-get
Responses
[
{
"access": "string",
"group": "string",
"groupicon": "string",
"help": "string",
"icon": "string",
"name": "string",
"navigable": true,
"order": "string",
"path": "string",
"published": true,
"region": null,
"schema": "string",
"subgroup": "string",
"subgroupicon": "string",
"version": "string"
}
]
Schema of the response body
{
"type": "array",
"items": {
"type": "object",
"properties": {
"access": {
"type": "string"
},
"group": {
"type": "string"
},
"groupicon": {
"type": "string"
},
"help": {
"type": "string"
},
"icon": {
"type": "string"
},
"name": {
"type": "string"
},
"navigable": {
"type": "boolean"
},
"order": {
"type": "string"
},
"path": {
"type": "string"
},
"published": {
"type": "boolean"
},
"region": {},
"schema": {
"type": "string"
},
"subgroup": {
"type": "string"
},
"subgroupicon": {
"type": "string"
},
"version": {
"type": "string"
}
}
}
}
EC2
GET /ec2
List EC2 for resource
Description
List EC2 for resource
Required permission: ec2-get
Request body
{
"resource_id": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"resource_id": {
"type": "string"
}
},
"required": [
"resource_id"
]
}
Responses
{
"access_key": "string",
"active": true,
"resource_id": "string",
"secret_key": "string",
"user_id": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"access_key": {
"type": "string"
},
"active": {
"type": "boolean"
},
"resource_id": {
"type": "string"
},
"secret_key": {
"type": "string"
},
"user_id": {
"type": "string"
}
}
}
PATCH /ec2
Set EC2 for resource
Description
Set EC2 for resource
Required permission: ec2-patch
Request body
{
"access_key": "string",
"resource_id": "string",
"secret_key": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"access_key": {
"type": "string"
},
"resource_id": {
"type": "string"
},
"secret_key": {
"type": "string"
}
},
"required": [
"access_key",
"resource_id",
"secret_key"
]
}
Responses
Kubernetes
GET /gardener/{namespace}/secretbindings
Get secret bindings from Kubernetes <> OpenStack backend.
Description
Get secret bindings from Kubernetes <> OpenStack backend.
Required permission: gardener_secret_bindings-get
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
namespace |
path | string | No |
Responses
[
{
"credentialsRef": {},
"metadata": {},
"provider": {}
}
]
Schema of the response body
{
"type": "array",
"items": {
"type": "object",
"properties": {
"credentialsRef": {
"type": "object",
"additionalProperties": true
},
"metadata": {
"type": "object",
"additionalProperties": true
},
"provider": {
"type": "object",
"additionalProperties": true
}
}
}
}
POST /gardener/{namespace}/secretbindings
Create secret bindings in Kubernetes <> OpenStack backend.
Description
Create secret bindings in Kubernetes <> OpenStack backend.
Required permission: gardener_secret_bindings-post
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
namespace |
path | string | No |
Request body
{
"secret_name": "string",
"secretbinding_name": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"secret_name": {
"type": "string"
},
"secretbinding_name": {
"type": "string"
}
},
"required": [
"secret_name",
"secretbinding_name"
]
}
Responses
{
"metadata": {},
"provider": {},
"secretRef": {}
}
Schema of the response body
{
"type": "object",
"properties": {
"metadata": {
"type": "object",
"additionalProperties": true
},
"provider": {
"type": "object",
"additionalProperties": true
},
"secretRef": {
"type": "object",
"additionalProperties": true
}
}
}
GET /gardener/{namespace}/secretbindings/{secret_binding_name}
Get the secret binding from Kubernetes <> OpenStack backend.
Description
Get the secret binding from Kubernetes <> OpenStack backend.
Required permission: gardener_secret_bindings_actions-get
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
namespace |
path | string | No | ||
secret_binding_name |
path | string | No |
Responses
[
{
"credentialsRef": {},
"metadata": {},
"provider": {}
}
]
Schema of the response body
{
"type": "array",
"items": {
"type": "object",
"properties": {
"credentialsRef": {
"type": "object",
"additionalProperties": true
},
"metadata": {
"type": "object",
"additionalProperties": true
},
"provider": {
"type": "object",
"additionalProperties": true
}
}
}
}
GET /gardener/{namespace}/secrets
Get secrets from Kubernetes <> OpenStack backend.
Description
Get secrets from Kubernetes <> OpenStack backend.
Required permission: gardener_secrets-get
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
namespace |
path | string | No |
Responses
[
{
"data": {},
"metadata": {},
"type": "string"
}
]
Schema of the response body
{
"type": "array",
"items": {
"type": "object",
"properties": {
"data": {
"type": "object",
"additionalProperties": true
},
"metadata": {
"type": "object",
"additionalProperties": true
},
"type": {
"type": "string"
}
}
}
}
POST /gardener/{namespace}/secrets
Create secrets in Kubernetes cluster <> OpenStack backend.
Description
Create secrets in Kubernetes cluster <> OpenStack backend.
Required permission: gardener_secrets-post
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
namespace |
path | string | No |
Request body
{
"app_credential_id": "string",
"app_credential_name": "string",
"app_credential_secret": "string",
"domain_name": "string",
"project_name": "string",
"secret_name": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"app_credential_id": {
"type": "string"
},
"app_credential_name": {
"type": "string"
},
"app_credential_secret": {
"type": "string"
},
"domain_name": {
"type": "string"
},
"project_name": {
"type": "string"
},
"secret_name": {
"type": "string"
}
},
"required": [
"app_credential_id",
"app_credential_name",
"app_credential_secret",
"domain_name",
"project_name",
"secret_name"
]
}
Responses
{
"data": {},
"metadata": {},
"type": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"data": {
"type": "object",
"additionalProperties": true
},
"metadata": {
"type": "object",
"additionalProperties": true
},
"type": {
"type": "string"
}
}
}
DELETE /gardener/{namespace}/secrets/{secret_name}
Delete a secret from Kubernetes <> OpenStack backend.
Description
Delete a secret from Kubernetes <> OpenStack backend.
Required permission: gardener_secret_actions-delete
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
namespace |
path | string | No | ||
secret_name |
path | string | No |
Responses
{
"apiVersion": "string",
"details": {},
"kind": "string",
"metadata": {},
"reason": "string",
"status": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"apiVersion": {
"type": "string"
},
"details": {
"type": "object",
"additionalProperties": true
},
"kind": {
"type": "string"
},
"metadata": {
"type": "object",
"additionalProperties": true
},
"reason": {
"type": "string"
},
"status": {
"type": "string"
}
}
}
GET /gardener/{namespace}/secrets/{secret_name}
Get the secret from Kubernetes <> Openstack backend.
Description
Get the secret from Kubernetes <> Openstack backend.
Required permission: gardener_secret_actions-get
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
namespace |
path | string | No | ||
secret_name |
path | string | No |
Responses
[
{
"data": {},
"metadata": {},
"type": "string"
}
]
Schema of the response body
{
"type": "array",
"items": {
"type": "object",
"properties": {
"data": {
"type": "object",
"additionalProperties": true
},
"metadata": {
"type": "object",
"additionalProperties": true
},
"type": {
"type": "string"
}
}
}
}
PATCH /gardener/{namespace}/secrets/{secret_name}
Update a secret in OpenStack <> Kubernetes backend.
Description
Update a secret in OpenStack <> Kubernetes backend.
Required permission: gardener_secret_actions-patch
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
namespace |
path | string | No | ||
secret_name |
path | string | No |
Request body
{
"app_credential_id": "string",
"app_credential_name": "string",
"app_credential_secret": "string",
"domain_name": "string",
"project_name": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"app_credential_id": {
"type": "string"
},
"app_credential_name": {
"type": "string"
},
"app_credential_secret": {
"type": "string"
},
"domain_name": {
"type": "string"
},
"project_name": {
"type": "string"
}
}
}
Responses
{
"data": {},
"metadata": {},
"type": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"data": {
"type": "object",
"additionalProperties": true
},
"metadata": {
"type": "object",
"additionalProperties": true
},
"type": {
"type": "string"
}
}
}
GET /gardener/{namespace}/shoots
Get all Kubernetes clusters.
Description
Get all Kubernetes clusters.
Required permission: gardener_shoots-get
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
namespace |
path | string | No |
Responses
[
{
"metadata": {},
"spec": {},
"status": {}
}
]
Schema of the response body
{
"type": "array",
"items": {
"type": "object",
"properties": {
"metadata": {
"type": "object",
"additionalProperties": true
},
"spec": {
"type": "object",
"additionalProperties": true
},
"status": {
"type": "object",
"additionalProperties": true
}
}
}
}
POST /gardener/{namespace}/shoots
This method can be used to create shoots in Gardener.
Description
This method can be used to create shoots in Gardener.
Required permission: gardener_shoots-post
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
namespace |
path | string | No |
Request body
{
"cloud_profile_name": "string",
"image_name": "string",
"image_version": "string",
"kubernetes_version": "string",
"openstack_flavor": "string",
"purpose": "string",
"region": "string",
"secret_binding_name": "string",
"shoot_name": "string",
"zones": "string",
"maximum_workers": "string",
"minimum_workers": "string",
"network_type": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"cloud_profile_name": {
"type": "string"
},
"image_name": {
"type": "string"
},
"image_version": {
"type": "string"
},
"kubernetes_version": {
"type": "string"
},
"openstack_flavor": {
"type": "string"
},
"purpose": {
"type": "string"
},
"region": {
"type": "string"
},
"secret_binding_name": {
"type": "string"
},
"shoot_name": {
"type": "string"
},
"zones": {
"type": "string"
},
"maximum_workers": {
"type": "string"
},
"minimum_workers": {
"type": "string"
},
"network_type": {
"type": "string"
}
},
"required": [
"cloud_profile_name",
"image_name",
"image_version",
"kubernetes_version",
"openstack_flavor",
"purpose",
"region",
"secret_binding_name",
"shoot_name",
"zones"
]
}
Responses
{
"metadata": {},
"spec": {},
"status": {}
}
Schema of the response body
{
"type": "object",
"properties": {
"metadata": {
"type": "object",
"additionalProperties": true
},
"spec": {
"type": "object",
"additionalProperties": true
},
"status": {
"type": "object",
"additionalProperties": true
}
}
}
DELETE /gardener/{namespace}/shoots/{shoot_name}
Delete a Kubernetes cluster.
Description
Delete a Kubernetes cluster.
Required permission: gardener_shoot_actions-delete
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
namespace |
path | string | No | ||
shoot_name |
path | string | No |
Request body
{
"force": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"force": {
"type": "string"
}
}
}
Responses
{
"apiVersion": "string",
"details": {},
"kind": "string",
"metadata": {},
"reason": "string",
"status": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"apiVersion": {
"type": "string"
},
"details": {
"type": "object",
"additionalProperties": true
},
"kind": {
"type": "string"
},
"metadata": {
"type": "object",
"additionalProperties": true
},
"reason": {
"type": "string"
},
"status": {
"type": "string"
}
}
}
GET /gardener/{namespace}/shoots/{shoot_name}
Get the Kubernetes cluster definition.
Description
Get the Kubernetes cluster definition.
Required permission: gardener_shoot_actions-get
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
namespace |
path | string | No | ||
shoot_name |
path | string | No |
Responses
[
{
"metadata": {},
"spec": {},
"status": {}
}
]
Schema of the response body
{
"type": "array",
"items": {
"type": "object",
"properties": {
"metadata": {
"type": "object",
"additionalProperties": true
},
"spec": {
"type": "object",
"additionalProperties": true
},
"status": {
"type": "object",
"additionalProperties": true
}
}
}
}
PATCH /gardener/{namespace}/shoots/{shoot_name}
This method can be used to update a Kubernetes cluster. If one tries to update the data for the worker group, we will assume an update for the default worker group created by the system. Therefore, if it does not exist, an error will be thrown.
Description
This method can be used to update a Kubernetes cluster. If one tries to update the data for the worker group, we will assume an update for the default worker group created by the system. Therefore, if it does not exist, an error will be thrown.
Required permission: gardener_shoot_actions-patch
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
namespace |
path | string | No | ||
shoot_name |
path | string | No |
Request body
{
"image_name": "string",
"image_version": "string",
"kubernetes_version": "string",
"maximum_workers": "string",
"minimum_workers": "string",
"openstack_flavor": "string",
"purpose": "string",
"secret_binding_name": "string",
"zones": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"image_name": {
"type": "string"
},
"image_version": {
"type": "string"
},
"kubernetes_version": {
"type": "string"
},
"maximum_workers": {
"type": "string"
},
"minimum_workers": {
"type": "string"
},
"openstack_flavor": {
"type": "string"
},
"purpose": {
"type": "string"
},
"secret_binding_name": {
"type": "string"
},
"zones": {
"type": "string"
}
}
}
Responses
{
"metadata": {},
"spec": {},
"status": {}
}
Schema of the response body
{
"type": "object",
"properties": {
"metadata": {
"type": "object",
"additionalProperties": true
},
"spec": {
"type": "object",
"additionalProperties": true
},
"status": {
"type": "object",
"additionalProperties": true
}
}
}
GET /gardener/{namespace}/shoots/{shoot_name}/adminkubeconfig
Retrieve the admin Kubeconfig from Kubernetes.
Description
Retrieve the admin Kubeconfig from Kubernetes.
Required permission: gardener_shoot_kube_admin_config_actions-get
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
namespace |
path | string | No | ||
shoot_name |
path | string | No |
Request body
{
"expiration_seconds": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"expiration_seconds": {
"type": "string"
}
}
}
Responses
{
"expirationSeconds": 0,
"expirationTimestamp": "string",
"kubeconfig": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"expirationSeconds": {
"type": "integer"
},
"expirationTimestamp": {
"type": "string"
},
"kubeconfig": {
"type": "string"
}
}
}
GET /gardener/{namespace}/shoots/{shoot_name}/viewerkubeconfig
Retrieve the shoot viewer Kubeconfig from Kubernetes.
Description
Retrieve the shoot viewer Kubeconfig from Kubernetes.
Required permission: gardener_shoot_kube_viwer_config_actions-get
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
namespace |
path | string | No | ||
shoot_name |
path | string | No |
Request body
{
"expiration_seconds": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"expiration_seconds": {
"type": "string"
}
}
}
Responses
{
"expirationSeconds": 0,
"expirationTimestamp": "string",
"kubeconfig": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"expirationSeconds": {
"type": "integer"
},
"expirationTimestamp": {
"type": "string"
},
"kubeconfig": {
"type": "string"
}
}
}
GET /gardener/{namespace}/shoots/{shoot_name}/workergroups
Return all of the worker groups configured for a Kubernetes cluster.
Description
Return all of the worker groups configured for a Kubernetes cluster.
Required permission: gardener_shoot_worker_groups-get
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
namespace |
path | string | No | ||
shoot_name |
path | string | No |
Responses
[
{
"machine": {},
"maximum": 0,
"minimum": 0,
"name": "string",
"zones": []
}
]
Schema of the response body
{
"type": "array",
"items": {
"type": "object",
"properties": {
"machine": {
"type": "object",
"additionalProperties": true
},
"maximum": {
"type": "integer"
},
"minimum": {
"type": "integer"
},
"name": {
"type": "string"
},
"zones": {
"type": "array"
}
}
}
}
POST /gardener/{namespace}/shoots/{shoot_name}/workergroups
Add a worker group in a Kubernete cluster.
Description
Add a worker group in a Kubernete cluster.
Required permission: gardener_shoot_worker_groups-post
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
namespace |
path | string | No | ||
shoot_name |
path | string | No |
Request body
{
"image_name": "string",
"image_version": "string",
"maximum_workers": "string",
"minimum_workers": "string",
"openstack_flavor": "string",
"worker_name": "string",
"zones": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"image_name": {
"type": "string"
},
"image_version": {
"type": "string"
},
"maximum_workers": {
"type": "string"
},
"minimum_workers": {
"type": "string"
},
"openstack_flavor": {
"type": "string"
},
"worker_name": {
"type": "string"
},
"zones": {
"type": "string"
}
},
"required": [
"image_name",
"image_version",
"maximum_workers",
"minimum_workers",
"openstack_flavor",
"worker_name",
"zones"
]
}
Responses
{
"metadata": {},
"spec": {},
"status": {}
}
Schema of the response body
{
"type": "object",
"properties": {
"metadata": {
"type": "object",
"additionalProperties": true
},
"spec": {
"type": "object",
"additionalProperties": true
},
"status": {
"type": "object",
"additionalProperties": true
}
}
}
DELETE /gardener/{namespace}/shoots/{shoot_name}/workergroups/{worker_group_name}
Delete a worker group definition.
Description
Delete a worker group definition.
Required permission: gardener_shoot_worker_groups_operations-delete
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
namespace |
path | string | No | ||
shoot_name |
path | string | No | ||
worker_group_name |
path | string | No |
Responses
{
"metadata": {},
"spec": {},
"status": {}
}
Schema of the response body
{
"type": "object",
"properties": {
"metadata": {
"type": "object",
"additionalProperties": true
},
"spec": {
"type": "object",
"additionalProperties": true
},
"status": {
"type": "object",
"additionalProperties": true
}
}
}
GET /gardener/{namespace}/shoots/{shoot_name}/workergroups/{worker_group_name}
Get a worker group definition in a given Kubernetes cluster.
Description
Get a worker group definition in a given Kubernetes cluster.
Required permission: gardener_shoot_worker_groups_operations-get
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
namespace |
path | string | No | ||
shoot_name |
path | string | No | ||
worker_group_name |
path | string | No |
Responses
{
"machine": {},
"maximum": 0,
"minimum": 0,
"name": "string",
"zones": []
}
Schema of the response body
{
"type": "object",
"properties": {
"machine": {
"type": "object",
"additionalProperties": true
},
"maximum": {
"type": "integer"
},
"minimum": {
"type": "integer"
},
"name": {
"type": "string"
},
"zones": {
"type": "array"
}
}
}
PATCH /gardener/{namespace}/shoots/{shoot_name}/workergroups/{worker_group_name}
Update a worker group definition.
Description
Update a worker group definition.
Required permission: gardener_shoot_worker_groups_operations-patch
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
namespace |
path | string | No | ||
shoot_name |
path | string | No | ||
worker_group_name |
path | string | No |
Request body
{
"image_name": "string",
"image_version": "string",
"maximum_workers": "string",
"minimum_workers": "string",
"openstack_flavor": "string",
"zones": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"image_name": {
"type": "string"
},
"image_version": {
"type": "string"
},
"maximum_workers": {
"type": "string"
},
"minimum_workers": {
"type": "string"
},
"openstack_flavor": {
"type": "string"
},
"zones": {
"type": "string"
}
}
}
Responses
{
"metadata": {},
"spec": {},
"status": {}
}
Schema of the response body
{
"type": "object",
"properties": {
"metadata": {
"type": "object",
"additionalProperties": true
},
"spec": {
"type": "object",
"additionalProperties": true
},
"status": {
"type": "object",
"additionalProperties": true
}
}
}
GET /gardener/cloudprofile/{cloudprofilename}
Access a Kubernetes cloud profile configurations.
Description
Access a Kubernetes cloud profile configurations.
Required permission: gardener_cloud_profile-get
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cloudprofilename |
path | string | No |
Responses
[
{
"metadata": {},
"spec": {}
}
]
Schema of the response body
{
"type": "array",
"items": {
"type": "object",
"properties": {
"metadata": {
"type": "object",
"additionalProperties": true
},
"spec": {
"type": "object",
"additionalProperties": true
}
}
}
}
GET /gardener/cloudprofile/{cloudprofilename}/images
List VM images configured for the cloudprofile to be used with Kubernetes.
Description
List VM images configured for the cloudprofile to be used with Kubernetes.
Required permission: gardener_images-get
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cloudprofilename |
path | string | No |
Responses
[
{
"name": "string",
"versions": []
}
]
Schema of the response body
{
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"versions": {
"type": "array"
}
}
}
}
GET /gardener/cloudprofile/{cloudprofilename}/kubernetes-versions
List Kubernetes versions configured for the cloud profile.
Description
List Kubernetes versions configured for the cloud profile.
Required permission: gardener_kubernetes_versions-get
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cloudprofilename |
path | string | No |
Responses
{
"defaultVersion": "string",
"versions": []
}
Schema of the response body
{
"type": "object",
"properties": {
"defaultVersion": {
"type": "string"
},
"versions": {
"type": "array"
}
}
}
GET /gardener/cloudprofile/{cloudprofilename}/machine-types
List the VM flavors configured for the cloudprofile to be used with Kubernetes.
Description
List the VM flavors configured for the cloudprofile to be used with Kubernetes.
Required permission: gardener_machine_types-get
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cloudprofilename |
path | string | No |
Responses
[
{
"architecture": "string",
"cpu": "string",
"gpu": "string",
"memory": "string",
"name": "string",
"storage": {},
"usable": true
}
]
Schema of the response body
{
"type": "array",
"items": {
"type": "object",
"properties": {
"architecture": {
"type": "string"
},
"cpu": {
"type": "string"
},
"gpu": {
"type": "string"
},
"memory": {
"type": "string"
},
"name": {
"type": "string"
},
"storage": {
"type": "object",
"additionalProperties": true
},
"usable": {
"type": "boolean"
}
}
}
}
GET /gardener/cloudprofile/{cloudprofilename}/regions
List regions and AZs available to create Kubernetes clusters.
Description
List regions and AZs available to create Kubernetes clusters.
Required permission: gardener_regions-get
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cloudprofilename |
path | string | No |
Responses
[
{
"name": "string",
"zones": []
}
]
Schema of the response body
{
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"zones": {
"type": "array"
}
}
}
}
GET /gardener/cloudprofiles
Access Kubernetes cloud profile configurations.
Description
Access Kubernetes cloud profile configurations.
Required permission: gardener_cloud_profiles-get
Request body
{
"cloudprofilename": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"cloudprofilename": {
"type": "string"
}
}
}
Responses
[
{
"metadata": {},
"spec": {}
}
]
Schema of the response body
{
"type": "array",
"items": {
"type": "object",
"properties": {
"metadata": {
"type": "object",
"additionalProperties": true
},
"spec": {
"type": "object",
"additionalProperties": true
}
}
}
}
GET /gardener/projects
List all Kubernetes projects definition.
Description
List all Kubernetes projects definition.
Required permission: gardener_projects-get
Request body
{
"namespace_filter": "string",
"project_name": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"namespace_filter": {
"type": "string"
},
"project_name": {
"type": "string"
}
}
}
Responses
[
{
"metadata": {},
"spec": {},
"status": {}
}
]
Schema of the response body
{
"type": "array",
"items": {
"type": "object",
"properties": {
"metadata": {
"type": "object",
"additionalProperties": true
},
"spec": {
"type": "object",
"additionalProperties": true
},
"status": {
"type": "object",
"additionalProperties": true
}
}
}
}
POST /gardener/projects
Create a Kubernetes project.
Description
Create a Kubernetes project.
Required permission: gardener_projects-post
Request body
{
"project_id": "string",
"purpose": "string",
"description": "string",
"owner": "string",
"reseller_prefix": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"project_id": {
"type": "string"
},
"purpose": {
"type": "string"
},
"description": {
"type": "string"
},
"owner": {
"type": "string"
},
"reseller_prefix": {
"type": "string"
}
},
"required": [
"project_id",
"purpose"
]
}
Responses
{
"metadata": {},
"spec": {},
"status": {}
}
Schema of the response body
{
"type": "object",
"properties": {
"metadata": {
"type": "object",
"additionalProperties": true
},
"spec": {
"type": "object",
"additionalProperties": true
},
"status": {
"type": "object",
"additionalProperties": true
}
}
}
DELETE /gardener/projects/{project_name}
Delete a Kubernetes project.
Description
Delete a Kubernetes project.
Required permission: gardener_project_action-delete
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
project_name |
path | string | No |
Request body
{
"force": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"force": {
"type": "string"
}
}
}
Responses
{
"msg": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"msg": {
"type": "string"
}
}
}
GET /gardener/projects/{project_name}
Get a Kubernetes project definition.
Description
Get a Kubernetes project definition.
Required permission: gardener_project_action-get
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
project_name |
path | string | No |
Responses
[
{
"metadata": {},
"spec": {},
"status": {}
}
]
Schema of the response body
{
"type": "array",
"items": {
"type": "object",
"properties": {
"metadata": {
"type": "object",
"additionalProperties": true
},
"spec": {
"type": "object",
"additionalProperties": true
},
"status": {
"type": "object",
"additionalProperties": true
}
}
}
}
PATCH /gardener/projects/{project_name}
Update a Kubernetes project configurations.
Description
Update a Kubernetes project configurations.
Required permission: gardener_project_action-patch
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
project_name |
path | string | No |
Request body
{
"description": "string",
"owner": "string",
"prepare_delete": "string",
"purpose": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"description": {
"type": "string"
},
"owner": {
"type": "string"
},
"prepare_delete": {
"type": "string"
},
"purpose": {
"type": "string"
}
}
}
Responses
{
"metadata": {},
"spec": {},
"status": {}
}
Schema of the response body
{
"type": "object",
"properties": {
"metadata": {
"type": "object",
"additionalProperties": true
},
"spec": {
"type": "object",
"additionalProperties": true
},
"status": {
"type": "object",
"additionalProperties": true
}
}
}
GET /gardener/shoots
List all Kubernetes clusters.
Description
List all Kubernetes clusters.
Required permission: gardener_all_shoots-get
Request body
{
"kubernetes_project_name": "string",
"shoot_name": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"kubernetes_project_name": {
"type": "string"
},
"shoot_name": {
"type": "string"
}
}
}
Responses
[
{
"kubernetes_cluster_project": {},
"openstack_domain_id": "string",
"openstack_domain_name": "string",
"openstack_project_id": "string",
"openstack_project_name": "string"
}
]
Schema of the response body
{
"type": "array",
"items": {
"type": "object",
"properties": {
"kubernetes_cluster_project": {
"type": "object",
"additionalProperties": true
},
"openstack_domain_id": {
"type": "string"
},
"openstack_domain_name": {
"type": "string"
},
"openstack_project_id": {
"type": "string"
},
"openstack_project_name": {
"type": "string"
}
}
}
}
Internationalization
GET /i18n/lang/{lang}
Get language tokens
Description
Get language tokens
Required permission: i18n_lang-get
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
lang |
path | string | No |
Responses
{
"<token>": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"<token>": {
"type": "string"
}
}
}
POST /i18n/lang/{lang}
Set language token
Description
Set language token
Required permission: i18n_lang-post
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
lang |
path | string | No |
Request body
{
"key": "string",
"value": "string",
"insert": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
},
"insert": {
"type": "string"
}
},
"required": [
"key",
"value"
]
}
Responses
GET /i18n/lang/{lang}/table
Get language tokens as a table
Description
Get language tokens as a table
Required permission: i18n_lang_table-get
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
lang |
path | string | No |
Responses
[
{
"key": "string",
"translated": true,
"value": "string"
}
]
Schema of the response body
{
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"translated": {
"type": "boolean"
},
"value": {
"type": "string"
}
}
}
}
GET /i18n/langs
List languages
Description
List languages
Required permission: i18n_langs-get
Responses
[
{
"default": true,
"lang": "string",
"name": "string"
}
]
Schema of the response body
{
"type": "array",
"items": {
"type": "object",
"properties": {
"default": {
"type": "boolean"
},
"lang": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
Notifications
GET /notification
List notifications for logged user.
Description
List notifications for logged user.
Required permission: notification-get
Request body
{
"unread": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"unread": {
"type": "string"
}
}
}
Responses
[
{
"client": "string",
"id": "string",
"notification": "string",
"provider": "string",
"read": "string",
"reseller": "string",
"timestamp": "string",
"type": "string",
"user": "string"
}
]
Schema of the response body
{
"type": "array",
"items": {
"type": "object",
"properties": {
"client": {
"type": "string"
},
"id": {
"type": "string"
},
"notification": {
"type": "string"
},
"provider": {
"type": "string"
},
"read": {
"type": "string"
},
"reseller": {
"type": "string"
},
"timestamp": {
"type": "string"
},
"type": {
"type": "string"
},
"user": {
"type": "string"
}
}
}
}
PATCH /notification
Read notification
Description
Read notification
Required permission: notification-patch
Request body
{
"id": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"id": {
"type": "string"
}
},
"required": [
"id"
]
}
Responses
OpenStack
GET /openstack/availability_zones
List all availability zones
Description
List all availability zones
Required permission: openstack_availability_zones-get
Responses
[
{
"zoneName": "string",
"zoneState": {}
}
]
Schema of the response body
{
"type": "array",
"items": {
"type": "object",
"properties": {
"zoneName": {
"type": "string"
},
"zoneState": {
"type": "object",
"additionalProperties": true
}
}
}
}
GET /openstack/credentials/{project_id}
List credentials for project
Description
List credentials for project
Required permission: openstack_credentials-get
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
project_id |
path | string | No |
Responses
[
{
"active": true,
"blob": "string",
"id": "string",
"project_id": "string",
"type": "string",
"user_id": "string",
"user_name": "string"
}
]
Schema of the response body
{
"type": "array",
"items": {
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"blob": {
"type": "string"
},
"id": {
"type": "string"
},
"project_id": {
"type": "string"
},
"type": {
"type": "string"
},
"user_id": {
"type": "string"
},
"user_name": {
"type": "string"
}
}
}
}
POST /openstack/credentials/{project_id}
Create credential for project
Description
Create credential for project
Required permission: openstack_credentials-post
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
project_id |
path | string | No |
Request body
{
"access_key": "string",
"description": "string",
"roles": "string",
"secret_key": "string",
"user_bound": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"access_key": {
"type": "string"
},
"description": {
"type": "string"
},
"roles": {
"type": "string"
},
"secret_key": {
"type": "string"
},
"user_bound": {
"type": "string"
}
},
"required": [
"access_key",
"description",
"roles",
"secret_key",
"user_bound"
]
}
Responses
{
"credential": {}
}
Schema of the response body
{
"type": "object",
"properties": {
"credential": {
"type": "object",
"additionalProperties": true
}
}
}
DELETE /openstack/credentials/{project_id}/credential/{credential_id}
Delete openstack credential
Description
Delete openstack credential
Required permission: openstack_credential-delete
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
credential_id |
path | string | No | ||
project_id |
path | string | No |
Responses
GET /openstack/domains
List OpenStack Domains
Description
List OpenStack Domains
Required permission: openstack_domains-get
Responses
[
{
"description": "string",
"enabled": true,
"id": "string",
"links": {},
"name": "string",
"options": {},
"tags": []
}
]
Schema of the response body
{
"type": "array",
"items": {
"type": "object",
"properties": {
"description": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"id": {
"type": "string"
},
"links": {
"type": "object",
"additionalProperties": true
},
"name": {
"type": "string"
},
"options": {
"type": "object",
"additionalProperties": true
},
"tags": {
"type": "array"
}
}
}
}
POST /openstack/domains
Create OpenStack Domain
Description
Create OpenStack Domain
Required permission: openstack_domains-post
Request body
{
"name": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"name": {
"type": "string"
}
},
"required": [
"name"
]
}
Responses
{
"domain": {}
}
Schema of the response body
{
"type": "object",
"properties": {
"domain": {
"type": "object",
"additionalProperties": true
}
}
}
GET /openstack/loadbalancers
List OpenStack Load Balancers
Description
List OpenStack Load Balancers
Required permission: openstack_loadbalancers-get
Responses
{
"healthmonitors": [],
"l7policies": [],
"l7rules": [],
"listeners": [],
"loadbalancers": [],
"members": [],
"pools": []
}
Schema of the response body
{
"type": "object",
"properties": {
"healthmonitors": {
"type": "array"
},
"l7policies": {
"type": "array"
},
"l7rules": {
"type": "array"
},
"listeners": {
"type": "array"
},
"loadbalancers": {
"type": "array"
},
"members": {
"type": "array"
},
"pools": {
"type": "array"
}
}
}
GET /openstack/networks
List OpenStack Networks
Description
List OpenStack Networks
Required permission: openstack_networks-get
Responses
{
"floating_ips": [],
"networks": [],
"ports": [],
"routers": [],
"security_groups": [],
"security_groups_rules": []
}
Schema of the response body
{
"type": "object",
"properties": {
"floating_ips": {
"type": "array"
},
"networks": {
"type": "array"
},
"ports": {
"type": "array"
},
"routers": {
"type": "array"
},
"security_groups": {
"type": "array"
},
"security_groups_rules": {
"type": "array"
}
}
}
DELETE /openstack/project/{project_id}
Delete OpenStack Project
Description
Delete OpenStack Project
Required permission: openstack_project-delete
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
project_id |
path | string | No |
Responses
PATCH /openstack/project/{project_id}/disable
Disable OpenStack Project
Description
Disable OpenStack Project
Required permission: openstack_project_disable-patch
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
project_id |
path | string | No |
Responses
PATCH /openstack/project/{project_id}/enable
Enable OpenStack Project
Description
Enable OpenStack Project
Required permission: openstack_project_enable-patch
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
project_id |
path | string | No |
Responses
GET /openstack/projects
List OpenStack Projects
Description
List OpenStack Projects
Required permission: openstack_projects-get
Request body
{
"domain": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"domain": {
"type": "string"
}
}
}
Responses
[
{
"client": "string",
"client_name": "string",
"description": "string",
"domain_id": "string",
"domain_name": "string",
"enabled": true,
"id": "string",
"name": "string",
"reseller": "string",
"updated": "string"
}
]
Schema of the response body
{
"type": "array",
"items": {
"type": "object",
"properties": {
"client": {
"type": "string"
},
"client_name": {
"type": "string"
},
"description": {
"type": "string"
},
"domain_id": {
"type": "string"
},
"domain_name": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"reseller": {
"type": "string"
},
"updated": {
"type": "string"
}
}
}
}
POST /openstack/projects
Create OpenStack Project
Description
Create OpenStack Project
Required permission: openstack_projects-post
Request body
{
"name": "string",
"quota_profile": "string",
"client": "string",
"description": "string",
"reseller": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"quota_profile": {
"type": "string"
},
"client": {
"type": "string"
},
"description": {
"type": "string"
},
"reseller": {
"type": "string"
}
},
"required": [
"name",
"quota_profile"
]
}
Responses
{
"project": {}
}
Schema of the response body
{
"type": "object",
"properties": {
"project": {
"type": "object",
"additionalProperties": true
}
}
}
POST /openstack/projects/quotas
Set quota on OpenStack project
Description
Set quota on OpenStack project
Required permission: openstack_projects_quotas-post
Request body
{
"client": "string",
"project_id": "string",
"reseller": "string",
"limit": "string",
"quota": "string",
"quota_profile": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"client": {
"type": "string"
},
"project_id": {
"type": "string"
},
"reseller": {
"type": "string"
},
"limit": {
"type": "string"
},
"quota": {
"type": "string"
},
"quota_profile": {
"type": "string"
}
},
"required": [
"client",
"project_id",
"reseller"
]
}
Responses
{
"api_export_size": 0,
"quota": {},
"quota_set": {},
"recordset_records": 0,
"zone_records": 0,
"zone_recordsets": 0,
"zones": 0
}
Schema of the response body
{
"type": "object",
"properties": {
"api_export_size": {
"type": "integer"
},
"quota": {
"type": "object",
"additionalProperties": true
},
"quota_set": {
"type": "object",
"additionalProperties": true
},
"recordset_records": {
"type": "integer"
},
"zone_records": {
"type": "integer"
},
"zone_recordsets": {
"type": "integer"
},
"zones": {
"type": "integer"
}
}
}
GET /openstack/servers
List OpenStack Servers
Description
List OpenStack Servers
Required permission: openstack_servers-get
Responses
[
{
"addresses": {},
"client": "string",
"created": "string",
"flavor": {},
"host_id": "string",
"id": "string",
"image": {},
"key_name": "string",
"metadata": {},
"name": "string",
"project_id": "string",
"project_name": "string",
"reseller": "string",
"status": "string",
"updated": "string",
"user_id": "string"
}
]
Schema of the response body
{
"type": "array",
"items": {
"type": "object",
"properties": {
"addresses": {
"type": "object",
"additionalProperties": true
},
"client": {
"type": "string"
},
"created": {
"type": "string"
},
"flavor": {
"type": "object",
"additionalProperties": true
},
"host_id": {
"type": "string"
},
"id": {
"type": "string"
},
"image": {
"type": "object",
"additionalProperties": true
},
"key_name": {
"type": "string"
},
"metadata": {
"type": "object",
"additionalProperties": true
},
"name": {
"type": "string"
},
"project_id": {
"type": "string"
},
"project_name": {
"type": "string"
},
"reseller": {
"type": "string"
},
"status": {
"type": "string"
},
"updated": {
"type": "string"
},
"user_id": {
"type": "string"
}
}
}
}
GET /openstack/volume_types
List all volume types
Description
List all volume types
Required permission: openstack_volume_types-get
Responses
[
{
"description": "string",
"extra_specs": {},
"id": "string",
"is_public": true,
"name": "string",
"qos_specs_id": null
}
]
Schema of the response body
{
"type": "array",
"items": {
"type": "object",
"properties": {
"description": {
"type": "string"
},
"extra_specs": {
"type": "object",
"additionalProperties": true
},
"id": {
"type": "string"
},
"is_public": {
"type": "boolean"
},
"name": {
"type": "string"
},
"qos_specs_id": {}
}
}
}
GET /openstack/volumes
List OpenStack Volumes
Description
List OpenStack Volumes
Required permission: openstack_volumes-get
Responses
{
"backups": [],
"snapshots": [],
"volumes": []
}
Schema of the response body
{
"type": "object",
"properties": {
"backups": {
"type": "array"
},
"snapshots": {
"type": "array"
},
"volumes": {
"type": "array"
}
}
}
Profiles
GET /profile
List profiles
Description
List profiles
Required permission: profile-get
Request body
{
"profile_type": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"profile_type": {
"type": "string"
}
}
}
Responses
[
{
"client": "string",
"description": "string",
"id": "string",
"inheritable": true,
"name": "string",
"provider": "string",
"reseller": "string",
"type": "string"
}
]
Schema of the response body
{
"type": "array",
"items": {
"type": "object",
"properties": {
"client": {
"type": "string"
},
"description": {
"type": "string"
},
"id": {
"type": "string"
},
"inheritable": {
"type": "boolean"
},
"name": {
"type": "string"
},
"provider": {
"type": "string"
},
"reseller": {
"type": "string"
},
"type": {
"type": "string"
}
}
}
}
DELETE /profile/assign
Unassign profile to entity
Description
Unassign profile to entity
Required permission: profile_assign-delete
Request body
{
"client_id": "string",
"entity": "string",
"profile_id": "string",
"profile_type": "string",
"reseller_name": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"client_id": {
"type": "string"
},
"entity": {
"type": "string"
},
"profile_id": {
"type": "string"
},
"profile_type": {
"type": "string"
},
"reseller_name": {
"type": "string"
}
},
"required": [
"client_id",
"entity",
"profile_id",
"profile_type",
"reseller_name"
]
}
Responses
PATCH /profile/assign
Define profiles to entity
Description
Define profiles to entity
Required permission: profile_assign-patch
Request body
{
"client_id": "string",
"entity": "string",
"profile_ids": "string",
"profile_type": "string",
"reseller_name": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"client_id": {
"type": "string"
},
"entity": {
"type": "string"
},
"profile_ids": {
"type": "string"
},
"profile_type": {
"type": "string"
},
"reseller_name": {
"type": "string"
}
},
"required": [
"client_id",
"entity",
"profile_ids",
"profile_type",
"reseller_name"
]
}
Responses
POST /profile/assign
Assign profile to entity
Description
Assign profile to entity
Required permission: profile_assign-post
Request body
{
"client_id": "string",
"entity": "string",
"profile_id": "string",
"profile_type": "string",
"reseller_name": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"client_id": {
"type": "string"
},
"entity": {
"type": "string"
},
"profile_id": {
"type": "string"
},
"profile_type": {
"type": "string"
},
"reseller_name": {
"type": "string"
}
},
"required": [
"client_id",
"entity",
"profile_id",
"profile_type",
"reseller_name"
]
}
Responses
GET /profile/dashboard/{name}
List dashboards for profile
Description
List dashboards for profile
Required permission: profile_dashboard-get
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
name |
path | string | No |
Responses
[
{
"enabled": true,
"name": "string"
}
]
Schema of the response body
{
"type": "array",
"items": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"name": {
"type": "string"
}
}
}
}
GET /profile/permission/{name}
List permissions for profile
Description
List permissions for profile
Required permission: profile_permissions-get
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
name |
path | string | No |
Responses
[
{
"description": "string",
"enabled": true,
"group": null,
"name": "string"
}
]
Schema of the response body
{
"type": "array",
"items": {
"type": "object",
"properties": {
"description": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"group": {},
"name": {
"type": "string"
}
}
}
}
GET /profile/profiles/{name}
List profiles for profile
Description
List profiles for profile
Required permission: profile_profiles-get
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
name |
path | string | No |
Responses
[
{
"description": "string",
"enabled": true,
"group": null,
"name": "string"
}
]
Schema of the response body
{
"type": "array",
"items": {
"type": "object",
"properties": {
"description": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"group": {},
"name": {
"type": "string"
}
}
}
}
GET /profile/quota
List profiles for quotas
Description
List profiles for quotas
Required permission: quota_profile-get
Responses
{
"my_quotas": {},
"profiles": []
}
Schema of the response body
{
"type": "object",
"properties": {
"my_quotas": {
"type": "object",
"additionalProperties": true
},
"profiles": {
"type": "array"
}
}
}
POST /profile/quota/{profile_id}
Set quota profile on entity
Description
Set quota profile on entity
Required permission: quota_profile_show-post
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
profile_id |
path | string | No |
Request body
{
"client_id": "string",
"reseller_name": "string",
"resource_id": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"client_id": {
"type": "string"
},
"reseller_name": {
"type": "string"
},
"resource_id": {
"type": "string"
}
}
}
Responses
GET /profiles/tree
List profile tree
Description
List profile tree
Required permission: profiles_tree-get
Responses
[
{
"children": [],
"client": "string",
"description": "string",
"expanded": true,
"id": "string",
"inheritable": true,
"name": "string",
"parents_ids": [],
"provider": "string",
"reseller": "string",
"type": "string"
}
]
Schema of the response body
{
"type": "array",
"items": {
"type": "object",
"properties": {
"children": {
"type": "array"
},
"client": {
"type": "string"
},
"description": {
"type": "string"
},
"expanded": {
"type": "boolean"
},
"id": {
"type": "string"
},
"inheritable": {
"type": "boolean"
},
"name": {
"type": "string"
},
"parents_ids": {
"type": "array"
},
"provider": {
"type": "string"
},
"reseller": {
"type": "string"
},
"type": {
"type": "string"
}
}
}
}
Property
GET /property
List properties
Description
List properties
Required permission: property-get
Responses
[
{
"description": "string",
"inherited": true,
"property": "string",
"value": "string"
}
]
Schema of the response body
{
"type": "array",
"items": {
"type": "object",
"properties": {
"description": {
"type": "string"
},
"inherited": {
"type": "boolean"
},
"property": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
}
POST /property
Create or Update property
Description
Create or Update property
Required permission: property-post
Request body
{
"description": "string",
"property": "string",
"value": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"description": {
"type": "string"
},
"property": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"description",
"property",
"value"
]
}
Responses
Quotas
GET /quota
List quotas
Description
List quotas
Required permission: quota-get
Responses
{
"<quota>": []
}
Schema of the response body
{
"type": "object",
"properties": {
"<quota>": {
"type": "array"
}
}
}
POST /quota
Add quota
Description
Add quota
Required permission: quota-post
Request body
{
"client_id": "string",
"limit": "string",
"quota": "string",
"reseller": "string",
"resource_id": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"client_id": {
"type": "string"
},
"limit": {
"type": "string"
},
"quota": {
"type": "string"
},
"reseller": {
"type": "string"
},
"resource_id": {
"type": "string"
}
},
"required": [
"client_id",
"limit",
"quota",
"reseller",
"resource_id"
]
}
Responses
Schema of the response body
{
"type": "object",
"additionalProperties": true
}
POST /quota/increase
Increase quotas
Description
Increase quotas
Required permission: quota_increase-post
Request body
{
"increase": "string",
"quotas": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"increase": {
"type": "string"
},
"quotas": {
"type": "string"
}
},
"required": [
"increase",
"quotas"
]
}
Responses
GET /quota/overview/line
Overview quotas line
Description
Overview quotas line
Required permission: quota_line-get
Responses
[
{
"allocation_rate": 10.12,
"client": "string",
"client_id": "string",
"current": 0,
"current_rel": 0,
"limit": 0,
"limit_rel": 0,
"parent_limit": 0,
"provider": "string",
"quota": "string",
"request_available": 0,
"reseller": "string",
"resource": "string",
"resource_id": "string",
"used": 0,
"used_rel": 0
}
]
Schema of the response body
{
"type": "array",
"items": {
"type": "object",
"properties": {
"allocation_rate": {
"type": "number"
},
"client": {
"type": "string"
},
"client_id": {
"type": "string"
},
"current": {
"type": "integer"
},
"current_rel": {
"type": "integer"
},
"limit": {
"type": "integer"
},
"limit_rel": {
"type": "integer"
},
"parent_limit": {
"type": "integer"
},
"provider": {
"type": "string"
},
"quota": {
"type": "string"
},
"request_available": {
"type": "integer"
},
"reseller": {
"type": "string"
},
"resource": {
"type": "string"
},
"resource_id": {
"type": "string"
},
"used": {
"type": "integer"
},
"used_rel": {
"type": "integer"
}
}
}
}
GET /quota/requests
List pending quota requests
Description
List pending quota requests
Required permission: quota_requests-get
Responses
[
{
"client": "string",
"client_name": "string",
"current": 0,
"date": null,
"limit": 0,
"my_limit": 0,
"my_used": 0,
"provider": "string",
"quota": "string",
"reseller": "string",
"resource": "string",
"resource_name": "string"
}
]
Schema of the response body
{
"type": "array",
"items": {
"type": "object",
"properties": {
"client": {
"type": "string"
},
"client_name": {
"type": "string"
},
"current": {
"type": "integer"
},
"date": {},
"limit": {
"type": "integer"
},
"my_limit": {
"type": "integer"
},
"my_used": {
"type": "integer"
},
"provider": {
"type": "string"
},
"quota": {
"type": "string"
},
"reseller": {
"type": "string"
},
"resource": {
"type": "string"
},
"resource_name": {
"type": "string"
}
}
}
}
PATCH /quota/requests/accept
Accept pending quotas
Description
Accept pending quotas
Required permission: quota_requests_accept-patch
Request body
{
"quotas": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"quotas": {
"type": "string"
}
},
"required": [
"quotas"
]
}
Responses
PATCH /quota/requests/reject
Reject pending quotas
Description
Reject pending quotas
Required permission: quota_requests_reject-patch
Request body
{
"quotas": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"quotas": {
"type": "string"
}
},
"required": [
"quotas"
]
}
Responses
GET /quota/tree
Get quotas tree
Description
Get quotas tree
Required permission: quota_tree-get
Responses
POST /quotas
Add quotas
Description
Add quotas
Required permission: quotas-post
Request body
{
"client_id": "string",
"quotas": "string",
"reseller": "string",
"resource_id": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"client_id": {
"type": "string"
},
"quotas": {
"type": "string"
},
"reseller": {
"type": "string"
},
"resource_id": {
"type": "string"
}
},
"required": [
"client_id",
"quotas",
"reseller",
"resource_id"
]
}
Responses
Users
PATCH /reseller/{name}/client/{client}/user/{id}/disable
Disable the client service
Description
Disable the client service
Required permission: user_disable-disable
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
client |
path | string | No | ||
id |
path | string | No | ||
name |
path | string | No |
Request body
{
"reseller": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"reseller": {
"type": "string"
}
},
"required": [
"reseller"
]
}
Responses
PATCH /reseller/{name}/client/{client}/user/{id}/enable
Activate the client service
Description
Activate the client service
Required permission: user_activate-enable
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
client |
path | string | No | ||
id |
path | string | No | ||
name |
path | string | No |
Request body
{
"reseller": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"reseller": {
"type": "string"
}
},
"required": [
"reseller"
]
}
Responses
PATCH /reseller/{name}/client/{client}/user/{id}/openstack/role/add
Add openstack role to user
Description
Add openstack role to user
Required permission: user_openstack_role-patch
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
client |
path | string | No | ||
id |
path | string | No | ||
name |
path | string | No |
Request body
{
"domain_id": "string",
"project_id": "string",
"role": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"domain_id": {
"type": "string"
},
"project_id": {
"type": "string"
},
"role": {
"type": "string"
}
},
"required": [
"domain_id",
"project_id",
"role"
]
}
Responses
DELETE /reseller/{name}/user/{id}
Delete customer portal user
Description
Delete customer portal user
Required permission: user_management_reseller-delete
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
id |
path | string | No | ||
name |
path | string | No |
Responses
{
"authorizations": {},
"client": "string",
"client_id": "string",
"clients": [],
"email": "string",
"enabled": "string",
"firstName": "string",
"icon": "string",
"id": "string",
"lastName": "string",
"name": "string",
"os_roles": {},
"permissions_profile": [],
"reseller": "string",
"services": [],
"username": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"authorizations": {
"type": "object",
"additionalProperties": true
},
"client": {
"type": "string"
},
"client_id": {
"type": "string"
},
"clients": {
"type": "array"
},
"email": {
"type": "string"
},
"enabled": {
"type": "string"
},
"firstName": {
"type": "string"
},
"icon": {
"type": "string"
},
"id": {
"type": "string"
},
"lastName": {
"type": "string"
},
"name": {
"type": "string"
},
"os_roles": {
"type": "object",
"additionalProperties": true
},
"permissions_profile": {
"type": "array"
},
"reseller": {
"type": "string"
},
"services": {
"type": "array"
},
"username": {
"type": "string"
}
}
}
POST /reseller/{reseller}/client/{client}/user
Create user
Description
Create user
Required permission: user-create
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
client |
path | string | No | ||
reseller |
path | string | No |
Request body
{
"description": "string",
"email": "string",
"first_name": "string",
"last_name": "string",
"name": "string",
"username": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"description": {
"type": "string"
},
"email": {
"type": "string"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"name": {
"type": "string"
},
"username": {
"type": "string"
}
},
"required": [
"description",
"email",
"first_name",
"last_name",
"name",
"username"
]
}
Responses
GET /reseller/{reseller}/client/{client}/user/{id}
Get user by id
Description
Get user by id
Required permission: user_id-get
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
client |
path | string | No | ||
id |
path | string | No | ||
reseller |
path | string | No |
Responses
PATCH /reseller/{reseller}/client/{client}/user/{id}
Update client
Description
Update client
Required permission: user_id-update
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
client |
path | string | No | ||
id |
path | string | No | ||
reseller |
path | string | No |
Request body
{
"attributes": "string",
"description": "string",
"name": "string",
"state": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"attributes": {
"type": "string"
},
"description": {
"type": "string"
},
"name": {
"type": "string"
},
"state": {
"type": "string"
}
}
}
Responses
GET /reseller/{reseller}/client/{client}/users
List users
Description
List users
Required permission: users-list
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
client |
path | string | No | ||
reseller |
path | string | No |
Request body
{
"[reseller]": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"[reseller]": {
"type": "string"
}
},
"required": [
"[reseller]"
]
}
Responses
DELETE /reseller/{reseller}/user/{user_id}/dashboards
Remove dashboard from user.
Description
Remove dashboard from user.
Required permission: user_dashboards-delete
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
reseller |
path | string | No | ||
user_id |
path | string | No |
Request body
{
"permissions": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"permissions": {
"type": "string"
}
},
"required": [
"permissions"
]
}
Responses
GET /reseller/{reseller}/user/{user_id}/dashboards
List users dashboards permissions.
Description
List users dashboards permissions.
Required permission: user_dashboards-get
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
reseller |
path | string | No | ||
user_id |
path | string | No |
Responses
[
{
"enabled": true,
"name": "string"
}
]
Schema of the response body
{
"type": "array",
"items": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
},
"name": {
"type": "string"
}
}
}
}
PATCH /reseller/{reseller}/user/{user_id}/dashboards
Add dashboard to user.
Description
Add dashboard to user.
Required permission: user_dashboards-patch
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
reseller |
path | string | No | ||
user_id |
path | string | No |
Request body
{
"permissions": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"permissions": {
"type": "string"
}
},
"required": [
"permissions"
]
}
Responses
DELETE /reseller/{reseller}/user/{user_id}/permissions
Remove api permissions from user.
Description
Remove api permissions from user.
Required permission: user_permissions-delete
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
reseller |
path | string | No | ||
user_id |
path | string | No |
Request body
{
"permissions": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"permissions": {
"type": "string"
}
},
"required": [
"permissions"
]
}
Responses
GET /reseller/{reseller}/user/{user_id}/permissions
List users api permissions.
Description
List users api permissions.
Required permission: user_permissions-get
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
reseller |
path | string | No | ||
user_id |
path | string | No |
Responses
[
{
"description": "string",
"enabled": true,
"group": "string",
"name": "string"
}
]
Schema of the response body
{
"type": "array",
"items": {
"type": "object",
"properties": {
"description": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"group": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
}
PATCH /reseller/{reseller}/user/{user_id}/permissions
Add api permissions to user.
Description
Add api permissions to user.
Required permission: user_permissions-patch
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
reseller |
path | string | No | ||
user_id |
path | string | No |
Request body
{
"permissions": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"permissions": {
"type": "string"
}
},
"required": [
"permissions"
]
}
Responses
GET /user/details
Return Logged user's details
Description
Return Logged user's details
Required permission: details-get
Responses
{
"avatar": "string",
"lang": "string",
"permissions": [],
"theme": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"avatar": {
"type": "string"
},
"lang": {
"type": "string"
},
"permissions": {
"type": "array"
},
"theme": {
"type": "string"
}
}
}
POST /user/details
Update Logged user's details
Description
Update Logged user's details
Required permission: details-post
Request body
{
"avatar": "string",
"firstName": "string",
"lastName": "string",
"lang": "string",
"theme": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"avatar": {
"type": "string"
},
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"lang": {
"type": "string"
},
"theme": {
"type": "string"
}
},
"required": [
"avatar",
"firstName",
"lastName"
]
}
Responses
PATCH /user/details/theme
Toggle user theme
Description
Toggle user theme
Required permission: details_theme-patch
Responses
GET /user/table/metadata/{table_id}
Get table metadata for user
Description
Get table metadata for user
Required permission: table_metadata-get
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
table_id |
path | string | No |
Responses
{
"extra_data": {},
"table_id": "string",
"user_id": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"extra_data": {
"type": "object",
"additionalProperties": true
},
"table_id": {
"type": "string"
},
"user_id": {
"type": "string"
}
}
}
POST /user/table/metadata/{table_id}
Set table metadata for user
Description
Set table metadata for user
Required permission: table_metadata-post
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
table_id |
path | string | No |
Request body
{
"metadata": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"metadata": {
"type": "string"
}
},
"required": [
"metadata"
]
}
Responses
GET /users
List all users grouped by their organizations.
Description
List all users grouped by their organizations.
Required permission: users_all-get
Responses
[
{
"authorizations": {},
"client": "string",
"client_id": "string",
"clients": [],
"email": "string",
"enabled": "string",
"firstName": "string",
"icon": "string",
"id": "string",
"lastName": "string",
"name": "string",
"os_roles": {},
"permissions_profile": [],
"reseller": "string",
"services": [],
"username": "string"
}
]
Schema of the response body
{
"type": "array",
"items": {
"type": "object",
"properties": {
"authorizations": {
"type": "object",
"additionalProperties": true
},
"client": {
"type": "string"
},
"client_id": {
"type": "string"
},
"clients": {
"type": "array"
},
"email": {
"type": "string"
},
"enabled": {
"type": "string"
},
"firstName": {
"type": "string"
},
"icon": {
"type": "string"
},
"id": {
"type": "string"
},
"lastName": {
"type": "string"
},
"name": {
"type": "string"
},
"os_roles": {
"type": "object",
"additionalProperties": true
},
"permissions_profile": {
"type": "array"
},
"reseller": {
"type": "string"
},
"services": {
"type": "array"
},
"username": {
"type": "string"
}
}
}
}
Roles
POST /roles
User
Description
User
Required permission: users
Responses
PUT /roles
Client
Description
Client
Required permission: clients
Responses
S3
GET /s3/bucket_info
Backend S3 - Fast bucket info
Description
Backend S3 - Fast bucket info
Required permission: s3_bucket_info-get
Request body
{
"bucket": "string",
"project_id": "string",
"s3_url": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"bucket": {
"type": "string"
},
"project_id": {
"type": "string"
},
"s3_url": {
"type": "string"
}
},
"required": [
"bucket",
"project_id",
"s3_url"
]
}
Responses
{
"bucket": "string",
"explicit_placement": {},
"id": "string",
"num_shards": 0,
"owner": "string",
"placement_rule": "string",
"usage": {},
"zonegroup": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"bucket": {
"type": "string"
},
"explicit_placement": {
"type": "object",
"additionalProperties": true
},
"id": {
"type": "string"
},
"num_shards": {
"type": "integer"
},
"owner": {
"type": "string"
},
"placement_rule": {
"type": "string"
},
"usage": {
"type": "object",
"additionalProperties": true
},
"zonegroup": {
"type": "string"
}
}
}
DELETE /s3/folder
Backend S3 - Delete folder
Description
Backend S3 - Delete folder
Required permission: s3-delete
Request body
{
"bucket": "string",
"delete_versions": "string",
"prefix": "string",
"project_id": "string",
"s3_url": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"bucket": {
"type": "string"
},
"delete_versions": {
"type": "string"
},
"prefix": {
"type": "string"
},
"project_id": {
"type": "string"
},
"s3_url": {
"type": "string"
}
},
"required": [
"bucket",
"delete_versions",
"prefix",
"project_id",
"s3_url"
]
}
Responses
DELETE /s3/object
Backend S3 - Delete object
Description
Backend S3 - Delete object
Required permission: s3_object-delete
Request body
{
"bucket": "string",
"delete_versions": "string",
"key": "string",
"project_id": "string",
"s3_url": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"bucket": {
"type": "string"
},
"delete_versions": {
"type": "string"
},
"key": {
"type": "string"
},
"project_id": {
"type": "string"
},
"s3_url": {
"type": "string"
}
},
"required": [
"bucket",
"delete_versions",
"key",
"project_id",
"s3_url"
]
}
Responses
DELETE /s3/objects
Backend S3 - Delete all objects
Description
Backend S3 - Delete all objects
Required permission: s3_delete_objects-delete
Request body
{
"bucket": "string",
"project_id": "string",
"s3_url": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"bucket": {
"type": "string"
},
"project_id": {
"type": "string"
},
"s3_url": {
"type": "string"
}
},
"required": [
"bucket",
"project_id",
"s3_url"
]
}
Responses
DELETE /s3/objects/versions
Backend S3 - Delete all objects and its versions
Description
Backend S3 - Delete all objects and its versions
Required permission: s3_delete_objects_versions-delete
Request body
{
"bucket": "string",
"project_id": "string",
"s3_url": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"bucket": {
"type": "string"
},
"project_id": {
"type": "string"
},
"s3_url": {
"type": "string"
}
},
"required": [
"bucket",
"project_id",
"s3_url"
]
}
Responses
DELETE /s3/shared_bucket
Backend S3 - Remove shared bucket
Description
Backend S3 - Remove shared bucket
Required permission: s3_shared_bucket-delete
Request body
{
"bucket": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"bucket": {
"type": "string"
}
},
"required": [
"bucket"
]
}
Responses
GET /s3/shared_bucket
Backend S3 - List shared bucket
Description
Backend S3 - List shared bucket
Required permission: s3_shared_bucket-get
Responses
[
{
"bucket": "string",
"key": "string",
"user_id": "string"
}
]
Schema of the response body
{
"type": "array",
"items": {
"type": "object",
"properties": {
"bucket": {
"type": "string"
},
"key": {
"type": "string"
},
"user_id": {
"type": "string"
}
}
}
}
POST /s3/shared_bucket
Backend S3 - Add shared bucket
Description
Backend S3 - Add shared bucket
Required permission: s3_shared_bucket-post
Request body
{
"bucket": "string",
"project_id": "string",
"s3_url": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"bucket": {
"type": "string"
},
"project_id": {
"type": "string"
},
"s3_url": {
"type": "string"
}
},
"required": [
"bucket",
"project_id",
"s3_url"
]
}
Responses
GET /s3/shared_url
Backend S3 - Get shared url
Description
Backend S3 - Get shared url
Required permission: s3_shared_url-get
Request body
{
"bucket": "string",
"key": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"bucket": {
"type": "string"
},
"key": {
"type": "string"
}
},
"required": [
"bucket",
"key"
]
}
Responses
{
"bucket": "string",
"expire_date": "string",
"object_key": "string",
"url": "string",
"user_id": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"bucket": {
"type": "string"
},
"expire_date": {
"type": "string"
},
"object_key": {
"type": "string"
},
"url": {
"type": "string"
},
"user_id": {
"type": "string"
}
}
}
POST /s3/shared_url
Backend S3 - Set shared url
Description
Backend S3 - Set shared url
Required permission: s3_shared_url-post
Request body
{
"bucket": "string",
"expire": "string",
"key": "string",
"url": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"bucket": {
"type": "string"
},
"expire": {
"type": "string"
},
"key": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"bucket",
"expire",
"key",
"url"
]
}
Responses
Task
GET /task
List tasks
Description
List tasks
Required permission: task-get
Request body
{
"unread": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"unread": {
"type": "string"
}
}
}
Responses
[
{
"ended_at": null,
"id": "string",
"name": "string",
"read_at": null,
"start_at": null,
"state": "string",
"user_id": "string"
}
]
Schema of the response body
{
"type": "array",
"items": {
"type": "object",
"properties": {
"ended_at": {},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"read_at": {},
"start_at": {},
"state": {
"type": "string"
},
"user_id": {
"type": "string"
}
}
}
}
POST /task
Add task
Description
Add task
Required permission: task-post
Request body
{
"name": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"name": {
"type": "string"
}
},
"required": [
"name"
]
}
Responses
{
"id": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"id": {
"type": "string"
}
}
}
POST /task/{task_id}
Mark task as read
Description
Mark task as read
Required permission: task_read-post
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
task_id |
path | string | No |
Responses
POST /task/{task_id}/run
Run task
Description
Run task
Required permission: task_run-post
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
task_id |
path | string | No |
Responses
Schema of the response body
{
"type": "object",
"additionalProperties": true
}
GET /task/{task_id}/step
List task steps
Description
List task steps
Required permission: task_step-get
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
task_id |
path | string | No |
Responses
[
{
"description": "string",
"ended_at": null,
"id": 0,
"method": "string",
"params": "string",
"path": "string",
"response": "string",
"start_at": null,
"task_id": "string"
}
]
Schema of the response body
{
"type": "array",
"items": {
"type": "object",
"properties": {
"description": {
"type": "string"
},
"ended_at": {},
"id": {
"type": "integer"
},
"method": {
"type": "string"
},
"params": {
"type": "string"
},
"path": {
"type": "string"
},
"response": {
"type": "string"
},
"start_at": {},
"task_id": {
"type": "string"
}
}
}
}
POST /task/{task_id}/step
Add task step
Description
Add task step
Required permission: task_step-post
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
task_id |
path | string | No |
Request body
{
"description": "string",
"method": "string",
"params": "string",
"step_path": "string",
"step_id": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"description": {
"type": "string"
},
"method": {
"type": "string"
},
"params": {
"type": "string"
},
"step_path": {
"type": "string"
},
"step_id": {
"type": "string"
}
},
"required": [
"description",
"method",
"params",
"step_path"
]
}
Responses
{
"id": 0,
"task_id": "string"
}
Schema of the response body
{
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"task_id": {
"type": "string"
}
}
}
Themes
GET /theme
Get Theme
Description
Get Theme
Required permission: theme-get
Request body
{
"client_id": "string",
"reseller_id": "string"
}
Schema of the request body
{
"type": "object",
"properties": {
"client_id": {
"type": "string"
},
"reseller_id": {
"type": "string"
}
}
}
Responses
Tags
| Name | Description |
|---|---|
| AI | |
| Backups | |
| Context | |
| Dashboards | |
| EC2 | |
| Internationalization | |
| Kubernetes | |
| Notifications | |
| OpenStack | |
| Profiles | |
| Property | |
| Quotas | |
| Roles | |
| S3 | |
| Task | |
| Themes | |
| Users |