Environments

A grouping of clusters inside an organisation with optional custom user access.

List available pre-defined environment types.

HTTP Responses codes for "List available pre-defined environment types."
Status CodeDescription
200Request was successfully processed. The response body contains the requested data.
400Invalid request parameters. Please review the documentation for valid parameter values.
403You do not have the necessary permissions to access this resource.
404The requested resource could not be found. Please check the resource URL or identifier.
500An internal error occurred on the server.
GET /api/v1/environments/types

Response

    No Content

                
{
  "items": {
    "type": "string"
  },
  "type": "array"
}

List environments in an organisation.

Path Parameters:

  • organisationSlug

Query Parameters:

  • pageable (Optional. When omitted: pageSize=50, pageNumber=0, sortDirection=ASC)
HTTP Responses codes for "List environments in an organisation."
Status CodeDescription
200Request was successfully processed. The response body contains the requested data.
400Invalid request parameters. Please review the documentation for valid parameter values.
403You do not have the necessary permissions to access this resource.
404The requested resource could not be found. Please check the resource URL or identifier.
500An internal error occurred on the server.

Related Objects

EnvironmentResponse
  • createdAt date-time
  • deletedAt date-time
  • description string
  • id int64
  • identity uuid
  • modifiedAt date-time
  • name string
  • organisationSlug object
    One of #/components/schemas/Slug
  • purpose string
  • slug object
    One of #/components/schemas/Slug
  • totalClusters int64
  • totalCpu int64
  • totalMemory int64
  • type string
PageableObject
  • offset int64
  • pageNumber int32
  • pageSize int32
  • paged boolean
  • sort array
    List of #/components/schemas/SortObject
  • unpaged boolean
SortObject
  • ascending boolean
  • direction string
  • ignoreCase boolean
  • nullHandling string
  • property string
GET /api/v1/orgs/{organisationSlug}/environments

Response

  • content array
    List of #/components/schemas/EnvironmentResponse
  • empty boolean
  • first boolean
  • last boolean
  • number int32
  • numberOfElements int32
  • pageable object
    One of #/components/schemas/PageableObject
  • size int32
  • sort array
    List of #/components/schemas/SortObject
  • totalElements int64
  • totalPages int32
                
{
  "properties": {
    "content": {
      "items": {
        "$ref": "#/components/schemas/EnvironmentResponse"
      },
      "type": "array"
    },
    "empty": {
      "type": "boolean"
    },
    "first": {
      "type": "boolean"
    },
    "last": {
      "type": "boolean"
    },
    "number": {
      "format": "int32",
      "type": "integer"
    },
    "numberOfElements": {
      "format": "int32",
      "type": "integer"
    },
    "pageable": {
      "$ref": "#/components/schemas/PageableObject"
    },
    "size": {
      "format": "int32",
      "type": "integer"
    },
    "sort": {
      "items": {
        "$ref": "#/components/schemas/SortObject"
      },
      "type": "array"
    },
    "totalElements": {
      "format": "int64",
      "type": "integer"
    },
    "totalPages": {
      "format": "int32",
      "type": "integer"
    }
  },
  "type": "object"
}

Create an environments in an organisation.

Path Parameters:

  • organisationSlug
HTTP Responses codes for "Create an environments in an organisation."
Status CodeDescription
200Request was successfully processed. The response body contains the requested data.
400Invalid request parameters. Please review the documentation for valid parameter values.
403You do not have the necessary permissions to access this resource.
404The requested resource could not be found. Please check the resource URL or identifier.
500An internal error occurred on the server.
Request Body Parameters
  • description string

    max length: 500

  • name string Required

    min length: 3

    max length: 25

  • purpose string

    max length: 255

  • type string
    One of production staging development demo other

Related Objects

Slug
  • slugValue string
POST /api/v1/orgs/{organisationSlug}/environments

Response

  • createdAt date-time
  • deletedAt date-time
  • description string
  • id int64
  • identity uuid
  • modifiedAt date-time
  • name string
  • organisationSlug object
    One of #/components/schemas/Slug
  • purpose string
  • slug object
    One of #/components/schemas/Slug
  • totalClusters int64
  • totalCpu int64
  • totalMemory int64
  • type string
                
{
  "properties": {
    "createdAt": {
      "format": "date-time",
      "type": "string"
    },
    "deletedAt": {
      "format": "date-time",
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "id": {
      "format": "int64",
      "type": "integer"
    },
    "identity": {
      "format": "uuid",
      "type": "string"
    },
    "modifiedAt": {
      "format": "date-time",
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "organisationSlug": {
      "$ref": "#/components/schemas/Slug"
    },
    "purpose": {
      "type": "string"
    },
    "slug": {
      "$ref": "#/components/schemas/Slug"
    },
    "totalClusters": {
      "format": "int64",
      "type": "integer"
    },
    "totalCpu": {
      "format": "int64",
      "type": "integer"
    },
    "totalMemory": {
      "format": "int64",
      "type": "integer"
    },
    "type": {
      "type": "string"
    }
  },
  "type": "object"
}

Count environments in an organisation.

Path Parameters:

  • organisationSlug
HTTP Responses codes for "Count environments in an organisation."
Status CodeDescription
200Request was successfully processed. The response body contains the requested data.
400Invalid request parameters. Please review the documentation for valid parameter values.
403You do not have the necessary permissions to access this resource.
404The requested resource could not be found. Please check the resource URL or identifier.
500An internal error occurred on the server.
GET /api/v1/orgs/{organisationSlug}/environments/count

Response

  • count int64
                
{
  "properties": {
    "count": {
      "format": "int64",
      "type": "integer"
    }
  },
  "type": "object"
}

List available pre-defined environment types.

Path Parameters:

  • organisationSlug
HTTP Responses codes for "List available pre-defined environment types."
Status CodeDescription
200Request was successfully processed. The response body contains the requested data.
400Invalid request parameters. Please review the documentation for valid parameter values.
403You do not have the necessary permissions to access this resource.
404The requested resource could not be found. Please check the resource URL or identifier.
500An internal error occurred on the server.
GET /api/v1/orgs/{organisationSlug}/environments/types

Response

    No Content

                
{
  "items": {
    "type": "string"
  },
  "type": "array"
}

Delete an environment from an organisation.

Path Parameters:

  • organisationSlug
  • environmentSlug
HTTP Responses codes for "Delete an environment from an organisation."
Status CodeDescription
204Request was successfully processed, but there is no response body to return.
400Invalid request parameters. Please review the documentation for valid parameter values.
403You do not have the necessary permissions to access this resource.
404The requested resource could not be found. Please check the resource URL or identifier.
500An internal error occurred on the server.
DELETE /api/v1/orgs/{organisationSlug}/environments/{environmentSlug}

Response

    No Content

Get an environments in an organisation.

Path Parameters:

  • organisationSlug
  • environmentSlug
HTTP Responses codes for "Get an environments in an organisation."
Status CodeDescription
200Request was successfully processed. The response body contains the requested data.
400Invalid request parameters. Please review the documentation for valid parameter values.
403You do not have the necessary permissions to access this resource.
404The requested resource could not be found. Please check the resource URL or identifier.
500An internal error occurred on the server.

Related Objects

Slug
  • slugValue string
GET /api/v1/orgs/{organisationSlug}/environments/{environmentSlug}

Response

  • createdAt date-time
  • deletedAt date-time
  • description string
  • id int64
  • identity uuid
  • modifiedAt date-time
  • name string
  • organisationSlug object
    One of #/components/schemas/Slug
  • purpose string
  • slug object
    One of #/components/schemas/Slug
  • totalClusters int64
  • totalCpu int64
  • totalMemory int64
  • type string
                
{
  "properties": {
    "createdAt": {
      "format": "date-time",
      "type": "string"
    },
    "deletedAt": {
      "format": "date-time",
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "id": {
      "format": "int64",
      "type": "integer"
    },
    "identity": {
      "format": "uuid",
      "type": "string"
    },
    "modifiedAt": {
      "format": "date-time",
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "organisationSlug": {
      "$ref": "#/components/schemas/Slug"
    },
    "purpose": {
      "type": "string"
    },
    "slug": {
      "$ref": "#/components/schemas/Slug"
    },
    "totalClusters": {
      "format": "int64",
      "type": "integer"
    },
    "totalCpu": {
      "format": "int64",
      "type": "integer"
    },
    "totalMemory": {
      "format": "int64",
      "type": "integer"
    },
    "type": {
      "type": "string"
    }
  },
  "type": "object"
}

Update an environments in an organisation.

Path Parameters:

  • organisationSlug
  • environmentSlug
HTTP Responses codes for "Update an environments in an organisation."
Status CodeDescription
200Request was successfully processed. The response body contains the requested data.
400Invalid request parameters. Please review the documentation for valid parameter values.
403You do not have the necessary permissions to access this resource.
404The requested resource could not be found. Please check the resource URL or identifier.
500An internal error occurred on the server.
Request Body Parameters
  • description string

    max length: 500

  • name string

    min length: 3

    max length: 25

  • purpose string

    max length: 255

  • type string
    One of production staging development demo other

Related Objects

Slug
  • slugValue string
PATCH /api/v1/orgs/{organisationSlug}/environments/{environmentSlug}

Response

  • createdAt date-time
  • deletedAt date-time
  • description string
  • id int64
  • identity uuid
  • modifiedAt date-time
  • name string
  • organisationSlug object
    One of #/components/schemas/Slug
  • purpose string
  • slug object
    One of #/components/schemas/Slug
  • totalClusters int64
  • totalCpu int64
  • totalMemory int64
  • type string
                
{
  "properties": {
    "createdAt": {
      "format": "date-time",
      "type": "string"
    },
    "deletedAt": {
      "format": "date-time",
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "id": {
      "format": "int64",
      "type": "integer"
    },
    "identity": {
      "format": "uuid",
      "type": "string"
    },
    "modifiedAt": {
      "format": "date-time",
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "organisationSlug": {
      "$ref": "#/components/schemas/Slug"
    },
    "purpose": {
      "type": "string"
    },
    "slug": {
      "$ref": "#/components/schemas/Slug"
    },
    "totalClusters": {
      "format": "int64",
      "type": "integer"
    },
    "totalCpu": {
      "format": "int64",
      "type": "integer"
    },
    "totalMemory": {
      "format": "int64",
      "type": "integer"
    },
    "type": {
      "type": "string"
    }
  },
  "type": "object"
}
← Organisations
Cloud Providers →