Deployments API
Deployments management endpoints
Auto-generated from OpenAPI spec on 2025-10-02
GET /deployments
GET deployments
🔒 Authentication Required: Bearer token
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
orgId | query | Yes | Organization ID |
Responses
200 - Successful response
{}400 - Bad request
{
"error": "string",
"message": "string",
"code": "string",
"statusCode": 0
}401 - Unauthorized
{
"error": "string",
"message": "string",
"code": "string",
"statusCode": 0
}404 - Not found
{
"error": "string",
"message": "string",
"code": "string",
"statusCode": 0
}Examples
curl -X GET https://api.syaala.com/deployments \\
-H "Authorization: Bearer ${SYAALA_API_KEY}" \\
-H "Content-Type: application/json"POST /deployments
POST deployments
🔒 Authentication Required: Bearer token
Request Body
{}Responses
200 - Successful response
{}400 - Bad request
{
"error": "string",
"message": "string",
"code": "string",
"statusCode": 0
}401 - Unauthorized
{
"error": "string",
"message": "string",
"code": "string",
"statusCode": 0
}404 - Not found
{
"error": "string",
"message": "string",
"code": "string",
"statusCode": 0
}Examples
curl -X POST https://api.syaala.com/deployments \\
-H "Authorization: Bearer ${SYAALA_API_KEY}" \\
-H "Content-Type: application/json" \\
-d '{}'GET /deployments/validate
GET validate
🔒 Authentication Required: Bearer token
Responses
200 - Successful response
{}400 - Bad request
{
"error": "string",
"message": "string",
"code": "string",
"statusCode": 0
}401 - Unauthorized
{
"error": "string",
"message": "string",
"code": "string",
"statusCode": 0
}404 - Not found
{
"error": "string",
"message": "string",
"code": "string",
"statusCode": 0
}Examples
curl -X GET https://api.syaala.com/deployments/validate \\
-H "Authorization: Bearer ${SYAALA_API_KEY}" \\
-H "Content-Type: application/json"POST /deployments/validate
POST validate
🔒 Authentication Required: Bearer token
Request Body
{}Responses
200 - Successful response
{}400 - Bad request
{
"error": "string",
"message": "string",
"code": "string",
"statusCode": 0
}401 - Unauthorized
{
"error": "string",
"message": "string",
"code": "string",
"statusCode": 0
}404 - Not found
{
"error": "string",
"message": "string",
"code": "string",
"statusCode": 0
}Examples
curl -X POST https://api.syaala.com/deployments/validate \\
-H "Authorization: Bearer ${SYAALA_API_KEY}" \\
-H "Content-Type: application/json" \\
-d '{}'GET /deployments/outdated-templates
GET outdated-templates
🔒 Authentication Required: Bearer token
Responses
200 - Successful response
{}400 - Bad request
{
"error": "string",
"message": "string",
"code": "string",
"statusCode": 0
}401 - Unauthorized
{
"error": "string",
"message": "string",
"code": "string",
"statusCode": 0
}404 - Not found
{
"error": "string",
"message": "string",
"code": "string",
"statusCode": 0
}Examples
curl -X GET https://api.syaala.com/deployments/outdated-templates \\
-H "Authorization: Bearer ${SYAALA_API_KEY}" \\
-H "Content-Type: application/json"GET /recovery/deployments/{id}
GET id
🔒 Authentication Required: Bearer token
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | path | Yes | id identifier |
Responses
200 - Successful response
{}400 - Bad request
{
"error": "string",
"message": "string",
"code": "string",
"statusCode": 0
}401 - Unauthorized
{
"error": "string",
"message": "string",
"code": "string",
"statusCode": 0
}404 - Not found
{
"error": "string",
"message": "string",
"code": "string",
"statusCode": 0
}Examples
curl -X GET https://api.syaala.com/recovery/deployments/abc123 \\
-H "Authorization: Bearer ${SYAALA_API_KEY}" \\
-H "Content-Type: application/json"POST /recovery/deployments/{id}
POST id
🔒 Authentication Required: Bearer token
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | path | Yes | id identifier |
Request Body
{}Responses
200 - Successful response
{}400 - Bad request
{
"error": "string",
"message": "string",
"code": "string",
"statusCode": 0
}401 - Unauthorized
{
"error": "string",
"message": "string",
"code": "string",
"statusCode": 0
}404 - Not found
{
"error": "string",
"message": "string",
"code": "string",
"statusCode": 0
}Examples
curl -X POST https://api.syaala.com/recovery/deployments/abc123 \\
-H "Authorization: Bearer ${SYAALA_API_KEY}" \\
-H "Content-Type: application/json" \\
-d '{}'DELETE /recovery/deployments/{id}
DELETE id
🔒 Authentication Required: Bearer token
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | path | Yes | id identifier |
Responses
200 - Successful response
{}400 - Bad request
{
"error": "string",
"message": "string",
"code": "string",
"statusCode": 0
}401 - Unauthorized
{
"error": "string",
"message": "string",
"code": "string",
"statusCode": 0
}404 - Not found
{
"error": "string",
"message": "string",
"code": "string",
"statusCode": 0
}Examples
curl -X DELETE https://api.syaala.com/recovery/deployments/abc123 \\
-H "Authorization: Bearer ${SYAALA_API_KEY}" \\
-H "Content-Type: application/json"POST /deployments/{id}/share-as-template
POST share-as-template
🔒 Authentication Required: Bearer token
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | path | Yes | id identifier |
Request Body
{}Responses
200 - Successful response
{}400 - Bad request
{
"error": "string",
"message": "string",
"code": "string",
"statusCode": 0
}401 - Unauthorized
{
"error": "string",
"message": "string",
"code": "string",
"statusCode": 0
}404 - Not found
{
"error": "string",
"message": "string",
"code": "string",
"statusCode": 0
}Examples
curl -X POST https://api.syaala.com/deployments/abc123/share-as-template \\
-H "Authorization: Bearer ${SYAALA_API_KEY}" \\
-H "Content-Type: application/json" \\
-d '{}'GET /deployments/{id}/pricing
GET pricing
🔒 Authentication Required: Bearer token
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | path | Yes | id identifier |
orgId | query | Yes | Organization ID |
Responses
200 - Successful response
{}400 - Bad request
{
"error": "string",
"message": "string",
"code": "string",
"statusCode": 0
}401 - Unauthorized
{
"error": "string",
"message": "string",
"code": "string",
"statusCode": 0
}404 - Not found
{
"error": "string",
"message": "string",
"code": "string",
"statusCode": 0
}Examples
curl -X GET https://api.syaala.com/deployments/abc123/pricing \\
-H "Authorization: Bearer ${SYAALA_API_KEY}" \\
-H "Content-Type: application/json"GET /deployments/{id}/metrics
GET metrics
🔒 Authentication Required: Bearer token
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | path | Yes | id identifier |
orgId | query | Yes | Organization ID |
Responses
200 - Successful response
{}400 - Bad request
{
"error": "string",
"message": "string",
"code": "string",
"statusCode": 0
}401 - Unauthorized
{
"error": "string",
"message": "string",
"code": "string",
"statusCode": 0
}404 - Not found
{
"error": "string",
"message": "string",
"code": "string",
"statusCode": 0
}Examples
curl -X GET https://api.syaala.com/deployments/abc123/metrics \\
-H "Authorization: Bearer ${SYAALA_API_KEY}" \\
-H "Content-Type: application/json"GET /deployments/{id}/optimization
GET optimization
🔒 Authentication Required: Bearer token
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | path | Yes | id identifier |
orgId | query | Yes | Organization ID |
Responses
200 - Successful response
{}400 - Bad request
{
"error": "string",
"message": "string",
"code": "string",
"statusCode": 0
}401 - Unauthorized
{
"error": "string",
"message": "string",
"code": "string",
"statusCode": 0
}404 - Not found
{
"error": "string",
"message": "string",
"code": "string",
"statusCode": 0
}Examples
curl -X GET https://api.syaala.com/deployments/abc123/optimization \\
-H "Authorization: Bearer ${SYAALA_API_KEY}" \\
-H "Content-Type: application/json"POST /deployments/{id}/optimization
POST optimization
🔒 Authentication Required: Bearer token
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | path | Yes | id identifier |
Request Body
{}Responses
200 - Successful response
{}400 - Bad request
{
"error": "string",
"message": "string",
"code": "string",
"statusCode": 0
}401 - Unauthorized
{
"error": "string",
"message": "string",
"code": "string",
"statusCode": 0
}404 - Not found
{
"error": "string",
"message": "string",
"code": "string",
"statusCode": 0
}Examples
curl -X POST https://api.syaala.com/deployments/abc123/optimization \\
-H "Authorization: Bearer ${SYAALA_API_KEY}" \\
-H "Content-Type: application/json" \\
-d '{}'PUT /deployments/{id}/optimization
PUT optimization
🔒 Authentication Required: Bearer token
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | path | Yes | id identifier |
Request Body
{}Responses
200 - Successful response
{}400 - Bad request
{
"error": "string",
"message": "string",
"code": "string",
"statusCode": 0
}401 - Unauthorized
{
"error": "string",
"message": "string",
"code": "string",
"statusCode": 0
}404 - Not found
{
"error": "string",
"message": "string",
"code": "string",
"statusCode": 0
}Examples
curl -X PUT https://api.syaala.com/deployments/abc123/optimization \\
-H "Authorization: Bearer ${SYAALA_API_KEY}" \\
-H "Content-Type: application/json" \\
-d '{}'GET /deployments/{id}/logs
GET logs
🔒 Authentication Required: Bearer token
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | path | Yes | id identifier |
orgId | query | Yes | Organization ID |
Responses
200 - Successful response
{}400 - Bad request
{
"error": "string",
"message": "string",
"code": "string",
"statusCode": 0
}401 - Unauthorized
{
"error": "string",
"message": "string",
"code": "string",
"statusCode": 0
}404 - Not found
{
"error": "string",
"message": "string",
"code": "string",
"statusCode": 0
}Examples
curl -X GET https://api.syaala.com/deployments/abc123/logs \\
-H "Authorization: Bearer ${SYAALA_API_KEY}" \\
-H "Content-Type: application/json"POST /deployments/{id}/actions
POST actions
🔒 Authentication Required: Bearer token
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | path | Yes | id identifier |
Request Body
{}Responses
200 - Successful response
{}400 - Bad request
{
"error": "string",
"message": "string",
"code": "string",
"statusCode": 0
}401 - Unauthorized
{
"error": "string",
"message": "string",
"code": "string",
"statusCode": 0
}404 - Not found
{
"error": "string",
"message": "string",
"code": "string",
"statusCode": 0
}Examples
curl -X POST https://api.syaala.com/deployments/abc123/actions \\
-H "Authorization: Bearer ${SYAALA_API_KEY}" \\
-H "Content-Type: application/json" \\
-d '{}'POST /admin/deployments/bulk
POST bulk
🔒 Authentication Required: Bearer token
Request Body
{}Responses
200 - Successful response
{}400 - Bad request
{
"error": "string",
"message": "string",
"code": "string",
"statusCode": 0
}401 - Unauthorized
{
"error": "string",
"message": "string",
"code": "string",
"statusCode": 0
}404 - Not found
{
"error": "string",
"message": "string",
"code": "string",
"statusCode": 0
}Examples
curl -X POST https://api.syaala.com/admin/deployments/bulk \\
-H "Authorization: Bearer ${SYAALA_API_KEY}" \\
-H "Content-Type: application/json" \\
-d '{}'