Endpoints for deploying infrastructure resources, retrieving deployment status, and listing all deployments.
Endpoints for deploying infrastructure resources, retrieving deployment status, and listing all deployments.
/deployments
Retrieve a list of all deployments.
List of deployments retrieved successfully
This response does not contain any headers
List of deployments retrieved successfully
[
{
"id": "deploy_123",
"name": "My Deployment",
"description": "This is a deployment for my infrastructure.",
"infrastructure_id": "infra_123",
"environment": "production",
"strategy": "blue-green",
"parameters": {
"version": "v1.0.0",
"timeout": 30,
"tags": [
"release",
"production"
]
},
"status": "successful",
"created_at": "2023-05-18T12:34:56Z",
"updated_at": "2023-05-18T12:34:56Z"
},
{
"id": "deploy_456",
"name": "Another Deployment",
"description": "This is another deployment for my infrastructure.",
"infrastructure_id": "infra_456",
"environment": "staging",
"strategy": "rolling",
"parameters": {
"version": "v2.0.0",
"timeout": 45,
"tags": [
"test",
"staging"
]
},
"status": "in_progress",
"created_at": "2023-05-19T14:56:23Z",
"updated_at": "2023-05-19T14:56:23Z"
}
]
/deployments
Trigger a new deployment of infrastructure resources in the Nebularis platform.
name
string
required
The name of the deployment
description
string
A brief description of the deployment
infrastructure_id
string
required
The unique identifier of the infrastructure to be deployed
environment
string
required
The environment type for the deployment
strategy
string
required
The deployment strategy to be used
parameters
object
Additional parameters for the deployment
version
string
The version of the deployment
timeout
int
Timeout for the deployment process in minutes
tags
array
A list of tags associated with the deployment
Deployment created successfully
id
string
The unique identifier for the new deployment
name
string
The name of the new deployment
description
string
The description of the new deployment
infrastructure_id
string
The unique identifier of the infrastructure being deployed
environment
string
The environment type for the deployment
strategy
string
The deployment strategy used
parameters
object
Additional parameters for the deployment
version
string
The version of the deployment
timeout
int
Timeout for the deployment process in minutes
tags
array
A list of tags associated with the deployment
status
string
The current status of the deployment
created_at
string
The date and time when the deployment was created
updated_at
string
The date and time when the deployment was last updated
This response does not contain any headers
Invalid input
This response is empty
This response does not contain any headers
{
"name": "My Deployment",
"description": "This is a deployment for my infrastructure.",
"infrastructure_id": "infra_123",
"environment": "production",
"strategy": "blue-green",
"parameters": {
"version": "v1.0.0",
"timeout": 30,
"tags": [
"release",
"production"
]
}
}
Deployment created successfully
{
"id": "deploy_123",
"name": "My Deployment",
"description": "This is a deployment for my infrastructure.",
"infrastructure_id": "infra_123",
"environment": "production",
"strategy": "blue-green",
"parameters": {
"version": "v1.0.0",
"timeout": 30,
"tags": [
"release",
"production"
]
},
"status": "pending",
"created_at": "2023-05-18T12:34:56Z",
"updated_at": "2023-05-18T12:34:56Z"
}
/deployments/{id}
Retrieve the status and details of a specific deployment.
id
string
required
The unique identifier of the deployment
Deployment status retrieved successfully
id
string
The unique identifier of the deployment
name
string
The name of the deployment
description
string
The description of the deployment
infrastructure_id
string
The unique identifier of the infrastructure being deployed
environment
string
The environment type for the deployment
strategy
string
The deployment strategy used
parameters
object
Additional parameters for the deployment
version
string
The version of the deployment
timeout
int
Timeout for the deployment process in minutes
tags
array
A list of tags associated with the deployment
status
string
The current status of the deployment
created_at
string
The date and time when the deployment was created
updated_at
string
The date and time when the deployment was last updated
This response does not contain any headers
Deployment not found
This response is empty
This response does not contain any headers
Deployment status retrieved successfully
{
"id": "deploy_123",
"name": "My Deployment",
"description": "This is a deployment for my infrastructure.",
"infrastructure_id": "infra_123",
"environment": "production",
"strategy": "blue-green",
"parameters": {
"version": "v1.0.0",
"timeout": 30,
"tags": [
"release",
"production"
]
},
"status": "in_progress",
"created_at": "2023-05-18T12:34:56Z",
"updated_at": "2023-05-18T12:34:56Z"
}
/deployments/{id}
Delete a specific deployment.
id
string
required
The unique identifier of the deployment
Deployment deleted successfully
This response is empty
This response does not contain any headers
Deployment not found
This response is empty
This response does not contain any headers
/deployments/{id}
Update the details of a specific deployment.
name
string
required
The new name for the deployment
description
string
required
The new description for the deployment
strategy
string
required
The new deployment strategy to be used
parameters
object
Additional parameters for the deployment
version
string
The new version of the deployment
timeout
int
Timeout for the deployment process in minutes
tags
array
A new list of tags associated with the deployment
id
string
required
The unique identifier of the deployment
Deployment updated successfully
id
string
The unique identifier of the updated deployment
name
string
The name of the updated deployment
description
string
The description of the updated deployment
infrastructure_id
string
The unique identifier of the infrastructure being deployed
environment
string
The environment type for the deployment
strategy
string
The deployment strategy used
parameters
object
Additional parameters for the deployment
version
string
The version of the deployment
timeout
int
Timeout for the deployment process in minutes
tags
array
A list of tags associated with the deployment
status
string
The current status of the deployment
created_at
string
The date and time when the deployment was created
updated_at
string
The date and time when the deployment was last updated
This response does not contain any headers
Invalid input
This response is empty
This response does not contain any headers
Deployment not found
This response is empty
This response does not contain any headers
{
"name": "Updated Deployment",
"description": "This is an updated deployment for my infrastructure.",
"strategy": "rolling",
"parameters": {
"version": "v1.1.0",
"timeout": 40,
"tags": [
"updated",
"release"
]
}
}
Deployment updated successfully
{
"id": "deploy_123",
"name": "Updated Deployment",
"description": "This is an updated deployment for my infrastructure.",
"infrastructure_id": "infra_123",
"environment": "production",
"strategy": "rolling",
"parameters": {
"version": "v1.1.0",
"timeout": 40,
"tags": [
"updated",
"release"
]
},
"status": "in_progress",
"created_at": "2023-05-18T12:34:56Z",
"updated_at": "2023-05-18T12:34:56Z"
}