Get started
  • Nebularis API

Projects

Endpoints for managing projects including creating new projects, updating existing ones, retrieving project details, and deleting projects.

get /projects

List all projects

Retrieve a list of all projects.

Responses

List of projects retrieved successfully

Response body Headers

This response does not contain any headers

Response examples

List of projects retrieved successfully 

[
  {
    "id": "proj_123",
    "name": "My Project",
    "description": "This is a description of my project.",
    "cloud_provider": "aws",
    "region": "us-west-2",
    "environment": "production",
    "deployment_strategy": "blue-green",
    "monitoring_enabled": true,
    "status": "active",
    "tags": [
      "high-priority",
      "customer-facing"
    ],
    "created_at": "2023-05-18T12:34:56Z",
    "updated_at": "2023-05-18T12:34:56Z"
  },
  {
    "id": "proj_456",
    "name": "Another Project",
    "description": "This is a description of another project.",
    "cloud_provider": "gcp",
    "region": "us-central1",
    "environment": "development",
    "deployment_strategy": "canary",
    "monitoring_enabled": false,
    "status": "inactive",
    "tags": [
      "low-priority",
      "internal"
    ],
    "created_at": "2023-05-18T12:34:56Z",
    "updated_at": "2023-05-18T12:34:56Z"
  }
]
post /projects

Create a new project

Create a new project in the Nebularis platform.

name string required

The name of the project

description string required

A brief description of the project

cloud_provider string required

The cloud provider for the project

Enum
  • aws
  • azure
  • gcp
region string required

The primary region for the project's resources

environment string required

The environment type for the project

Enum
  • development
  • staging
  • production
deployment_strategy string

The deployment strategy for the project

Enum
  • blue-green
  • canary
  • rolling
monitoring_enabled boolean

Flag to enable or disable monitoring for the project

tags array

A list of tags associated with the project

Responses

Project created successfully

Response body Headers
id string

The unique identifier for the new project

name string

The name of the new project

description string

The description of the new project

cloud_provider string

The cloud provider for the project

region string

The primary region for the project's resources

environment string

The environment type for the project

deployment_strategy string

The deployment strategy for the project

monitoring_enabled boolean

Flag indicating if monitoring is enabled

status string

The current status of the project

Enum
  • active
  • inactive
  • archived
tags array

A list of tags associated with the project

created_at string

The date and time when the project was created

Format
date-time
updated_at string

The date and time when the project was last updated

Format
date-time

This response does not contain any headers

Invalid input

Response body Headers

This response is empty

This response does not contain any headers

Request examples

{
  "name": "My Project",
  "description": "This is a description of my project.",
  "cloud_provider": "aws",
  "region": "us-west-2",
  "environment": "production",
  "deployment_strategy": "blue-green",
  "monitoring_enabled": true,
  "tags": [
    "high-priority",
    "customer-facing"
  ]
}

Response examples

Project created successfully 

{
  "id": "proj_123",
  "name": "My Project",
  "description": "This is a description of my project.",
  "cloud_provider": "aws",
  "region": "us-west-2",
  "environment": "production",
  "deployment_strategy": "blue-green",
  "monitoring_enabled": true,
  "status": "active",
  "tags": [
    "high-priority",
    "customer-facing"
  ],
  "created_at": "2023-05-18T12:34:56Z",
  "updated_at": "2023-05-18T12:34:56Z"
}
get /projects/{id}

Get project information

Retrieve details of a specific project.

id string required

The unique identifier of the project

Responses

Project information retrieved successfully

Response body Headers
id string

The unique identifier of the project

name string

The name of the project

description string

The description of the project

cloud_provider string

The cloud provider for the project

region string

The primary region for the project's resources

environment string

The environment type for the project

deployment_strategy string

The deployment strategy for the project

monitoring_enabled boolean

Flag indicating if monitoring is enabled

status string

The current status of the project

Enum
  • active
  • inactive
  • archived
tags array

A list of tags associated with the project

created_at string

The date and time when the project was created

Format
date-time
updated_at string

The date and time when the project was last updated

Format
date-time

This response does not contain any headers

Project not found

Response body Headers

This response is empty

This response does not contain any headers

Response examples

Project information retrieved successfully 

{
  "id": "proj_123",
  "name": "My Project",
  "description": "This is a description of my project.",
  "cloud_provider": "aws",
  "region": "us-west-2",
  "environment": "production",
  "deployment_strategy": "blue-green",
  "monitoring_enabled": true,
  "status": "active",
  "tags": [
    "high-priority",
    "customer-facing"
  ],
  "created_at": "2023-05-18T12:34:56Z",
  "updated_at": "2023-05-18T12:34:56Z"
}
delete /projects/{id}

Delete a project

Delete a project.

id string required

The unique identifier of the project

Responses

Project deleted successfully

Response body Headers

This response is empty

This response does not contain any headers

Project not found

Response body Headers

This response is empty

This response does not contain any headers

Response examples

patch /projects/{id}

Update project information

Update the details of a specific project.

name string required

The new name for the project

description string required

The new description for the project

cloud_provider string

The new cloud provider for the project

Enum
  • aws
  • azure
  • gcp
region string

The new primary region for the project's resources

environment string

The new environment type for the project

Enum
  • development
  • staging
  • production
deployment_strategy string

The new deployment strategy for the project

Enum
  • blue-green
  • canary
  • rolling
monitoring_enabled boolean

Flag to enable or disable monitoring for the project

status string

The new status of the project

Enum
  • active
  • inactive
  • archived
tags array

A new list of tags associated with the project

id string required

The unique identifier of the project

Responses

Project information updated successfully

Response body Headers

This response is empty

This response does not contain any headers

Invalid input

Response body Headers

This response is empty

This response does not contain any headers

Project not found

Response body Headers

This response is empty

This response does not contain any headers

Request examples

{
  "name": "Updated Project",
  "description": "This is an updated description of the project.",
  "cloud_provider": "azure",
  "region": "eastus",
  "environment": "staging",
  "deployment_strategy": "canary",
  "monitoring_enabled": true,
  "status": "active",
  "tags": [
    "important",
    "backend"
  ]
}

Response examples