Organisations

Represents a group of users that manages Kubernetes resources.

Get accumulated compute information for an organisation.

Path Parameters:

  • organisationSlug
HTTP Responses codes for "Get accumulated compute information for 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/compute-information/organisation/{organisationSlug}

Response

  • totalClusters int64
  • totalCpu int64
  • totalMemory int64
                
{
  "properties": {
    "totalClusters": {
      "format": "int64",
      "type": "integer"
    },
    "totalCpu": {
      "format": "int64",
      "type": "integer"
    },
    "totalMemory": {
      "format": "int64",
      "type": "integer"
    }
  },
  "type": "object"
}
                    

Create an organisation.

HTTP Responses codes for "Create 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
  • acceptedAgreements array Required
    List of #/components/schemas/AcceptAgreementRequest
  • companyAddress string
  • companyName string
  • contactEmail object Required
    One of #/components/schemas/Email
  • organisationName string Required
  • organisationType string Required
  • vatNumber string

Related Objects

AcceptAgreementRequest
  • agreementSlug string
Email
  • email string
Slug
  • slugValue string
POST /api/v1/organisations

Response

  • acceptedTerms boolean
  • acceptedTermsAt date-time
  • billingEmail string
  • companyAddress string
  • companyName string
  • contactEmail string
  • createdAt date-time
  • id uuid
  • identity uuid
  • name string
  • phoneNumber string
  • restrictedToAvailableCloudProviders boolean
  • slug object
    One of #/components/schemas/Slug
  • type string
  • vatCode string
  • vatCodeValidated boolean
  • vatCodeValidatedAt date-time
                
{
  "properties": {
    "acceptedTerms": {
      "type": "boolean"
    },
    "acceptedTermsAt": {
      "format": "date-time",
      "type": "string"
    },
    "billingEmail": {
      "type": "string"
    },
    "companyAddress": {
      "type": "string"
    },
    "companyName": {
      "type": "string"
    },
    "contactEmail": {
      "type": "string"
    },
    "createdAt": {
      "format": "date-time",
      "type": "string"
    },
    "id": {
      "deprecated": true,
      "format": "uuid",
      "type": "string"
    },
    "identity": {
      "format": "uuid",
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "phoneNumber": {
      "type": "string"
    },
    "restrictedToAvailableCloudProviders": {
      "type": "boolean"
    },
    "slug": {
      "$ref": "#/components/schemas/Slug"
    },
    "type": {
      "enum": [
        "BUSINESS",
        "ENTERPRISE",
        "INDIVIDUAL",
        "TRIAL"
      ],
      "type": "string"
    },
    "vatCode": {
      "type": "string"
    },
    "vatCodeValidated": {
      "type": "boolean"
    },
    "vatCodeValidatedAt": {
      "format": "date-time",
      "type": "string"
    }
  },
  "type": "object"
}
                    

Delete an organisation (only possible if the organisation has no configured cloud accounts, no active clusters and no active monitoring tenants).

Path Parameters:

  • organisationIdentity
HTTP Responses codes for "Delete an organisation (only possible if the organisation has no configured cloud accounts, no active clusters and no active monitoring tenants)."
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/organisations/{organisationIdentity}

Response

    No Content

                
                    

Get an organisation.

Path Parameters:

  • organisationSlug
HTTP Responses codes for "Get 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/organisations/{organisationSlug}

Response

  • acceptedTerms boolean
  • acceptedTermsAt date-time
  • billingEmail string
  • companyAddress string
  • companyName string
  • contactEmail string
  • createdAt date-time
  • id uuid
  • identity uuid
  • name string
  • phoneNumber string
  • restrictedToAvailableCloudProviders boolean
  • slug object
    One of #/components/schemas/Slug
  • type string
  • vatCode string
  • vatCodeValidated boolean
  • vatCodeValidatedAt date-time
                
{
  "properties": {
    "acceptedTerms": {
      "type": "boolean"
    },
    "acceptedTermsAt": {
      "format": "date-time",
      "type": "string"
    },
    "billingEmail": {
      "type": "string"
    },
    "companyAddress": {
      "type": "string"
    },
    "companyName": {
      "type": "string"
    },
    "contactEmail": {
      "type": "string"
    },
    "createdAt": {
      "format": "date-time",
      "type": "string"
    },
    "id": {
      "deprecated": true,
      "format": "uuid",
      "type": "string"
    },
    "identity": {
      "format": "uuid",
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "phoneNumber": {
      "type": "string"
    },
    "restrictedToAvailableCloudProviders": {
      "type": "boolean"
    },
    "slug": {
      "$ref": "#/components/schemas/Slug"
    },
    "type": {
      "enum": [
        "BUSINESS",
        "ENTERPRISE",
        "INDIVIDUAL",
        "TRIAL"
      ],
      "type": "string"
    },
    "vatCode": {
      "type": "string"
    },
    "vatCodeValidated": {
      "type": "boolean"
    },
    "vatCodeValidatedAt": {
      "format": "date-time",
      "type": "string"
    }
  },
  "type": "object"
}
                    

Update organisation settings.

Path Parameters:

  • organisationSlug
HTTP Responses codes for "Update organisation settings."
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
  • billingEmail object
    One of #/components/schemas/Email
  • contactEmail object
    One of #/components/schemas/Email
  • organisationName string
  • organisationType string
  • vatNumber string

Related Objects

Email
  • email string
Slug
  • slugValue string
PATCH /api/v1/organisations/{organisationSlug}

Response

  • acceptedTerms boolean
  • acceptedTermsAt date-time
  • billingEmail string
  • companyAddress string
  • companyName string
  • contactEmail string
  • createdAt date-time
  • id uuid
  • identity uuid
  • name string
  • phoneNumber string
  • restrictedToAvailableCloudProviders boolean
  • slug object
    One of #/components/schemas/Slug
  • type string
  • vatCode string
  • vatCodeValidated boolean
  • vatCodeValidatedAt date-time
                
{
  "properties": {
    "acceptedTerms": {
      "type": "boolean"
    },
    "acceptedTermsAt": {
      "format": "date-time",
      "type": "string"
    },
    "billingEmail": {
      "type": "string"
    },
    "companyAddress": {
      "type": "string"
    },
    "companyName": {
      "type": "string"
    },
    "contactEmail": {
      "type": "string"
    },
    "createdAt": {
      "format": "date-time",
      "type": "string"
    },
    "id": {
      "deprecated": true,
      "format": "uuid",
      "type": "string"
    },
    "identity": {
      "format": "uuid",
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "phoneNumber": {
      "type": "string"
    },
    "restrictedToAvailableCloudProviders": {
      "type": "boolean"
    },
    "slug": {
      "$ref": "#/components/schemas/Slug"
    },
    "type": {
      "enum": [
        "BUSINESS",
        "ENTERPRISE",
        "INDIVIDUAL",
        "TRIAL"
      ],
      "type": "string"
    },
    "vatCode": {
      "type": "string"
    },
    "vatCodeValidated": {
      "type": "boolean"
    },
    "vatCodeValidatedAt": {
      "format": "date-time",
      "type": "string"
    }
  },
  "type": "object"
}
                    

GET /api/v1/organisations/{organisationSlug}/activity

Path Parameters:

  • organisationSlug

Query Parameters:

  • page
  • pageable (Optional. When omitted: pageSize=50, pageNumber=0, sortDirection=DESC, sort=createdAt)
HTTP Responses codes for ""
Status CodeDescription
200OK
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

ActivityEventResponse
  • actor object
    One of #/components/schemas/ActivityEventActor
  • createdAt date-time
  • message string
  • type string
PageableObject
  • offset int64
  • pageNumber int32
  • pageSize int32
  • paged boolean
  • sort object
    One of #/components/schemas/SortObject
  • unpaged boolean
SortObject
  • empty boolean
  • sorted boolean
  • unsorted boolean
GET /api/v1/organisations/{organisationSlug}/activity

Response

  • content array
    List of #/components/schemas/ActivityEventResponse
  • empty boolean
  • first boolean
  • last boolean
  • number int32
  • numberOfElements int32
  • pageable object
    One of #/components/schemas/PageableObject
  • size int32
  • sort object
    One of #/components/schemas/SortObject
  • totalElements int64
  • totalPages int32
                
{
  "properties": {
    "content": {
      "items": {
        "$ref": "#/components/schemas/ActivityEventResponse"
      },
      "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": {
      "$ref": "#/components/schemas/SortObject"
    },
    "totalElements": {
      "format": "int64",
      "type": "integer"
    },
    "totalPages": {
      "format": "int32",
      "type": "integer"
    }
  },
  "type": "object"
}
                    

Get the membership in an organisation for the user requesting this endpoint.

Path Parameters:

  • organisationSlug
HTTP Responses codes for "Get the membership in an organisation for the user requesting this endpoint."
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

Email
  • email string
GET /api/v1/organisations/{organisationSlug}/me

Response

  • email object
    One of #/components/schemas/Email
  • identity uuid
  • joinedAt date-time
  • kubernetesRole string
  • role string
  • subject uuid
  • username string
                
{
  "properties": {
    "email": {
      "$ref": "#/components/schemas/Email"
    },
    "identity": {
      "format": "uuid",
      "type": "string"
    },
    "joinedAt": {
      "format": "date-time",
      "type": "string"
    },
    "kubernetesRole": {
      "enum": [
        "CLUSTER_ADMIN",
        "EDIT",
        "VIEW",
        "NONE"
      ],
      "type": "string"
    },
    "role": {
      "type": "string"
    },
    "subject": {
      "format": "uuid",
      "type": "string"
    },
    "username": {
      "type": "string"
    }
  },
  "type": "object"
}
                    

List members in an organisation.

Path Parameters:

  • organisationSlug

Query Parameters:

  • pageable (Optional. When omitted: pageSize=50, pageNumber=0, sortDirection=ASC)
HTTP Responses codes for "List members 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

OrganisationMemberResponse
  • email object
    One of #/components/schemas/Email
  • identity uuid
  • joinedAt date-time
  • kubernetesRole string
    One of CLUSTER_ADMIN EDIT VIEW NONE
  • role string
  • subject uuid
  • username string
PageableObject
  • offset int64
  • pageNumber int32
  • pageSize int32
  • paged boolean
  • sort object
    One of #/components/schemas/SortObject
  • unpaged boolean
SortObject
  • empty boolean
  • sorted boolean
  • unsorted boolean
GET /api/v1/organisations/{organisationSlug}/members

Response

  • content array
    List of #/components/schemas/OrganisationMemberResponse
  • empty boolean
  • first boolean
  • last boolean
  • number int32
  • numberOfElements int32
  • pageable object
    One of #/components/schemas/PageableObject
  • size int32
  • sort object
    One of #/components/schemas/SortObject
  • totalElements int64
  • totalPages int32
                
{
  "properties": {
    "content": {
      "items": {
        "$ref": "#/components/schemas/OrganisationMemberResponse"
      },
      "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": {
      "$ref": "#/components/schemas/SortObject"
    },
    "totalElements": {
      "format": "int64",
      "type": "integer"
    },
    "totalPages": {
      "format": "int32",
      "type": "integer"
    }
  },
  "type": "object"
}
                    

Add a member to an organisation.

Path Parameters:

  • organisationSlug
HTTP Responses codes for "Add a member to 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
  • email object
    One of #/components/schemas/Email
  • kubernetesRole string
    One of CLUSTER_ADMIN EDIT VIEW NONE
  • role string
  • username string

Related Objects

Email
  • email string
POST /api/v1/organisations/{organisationSlug}/members

Response

    No Content

                
                    

Delete a member from an organisation.

Path Parameters:

  • organisationSlug
  • memberIdentity
HTTP Responses codes for "Delete a member 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/organisations/{organisationSlug}/members/{memberIdentity}

Response

    No Content

                
                    

Get quotas for an organisation.

Path Parameters:

  • organisationSlug
HTTP Responses codes for "Get quotas for 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/organisations/{organisationSlug}/quotas

Response

  • clustersPerCustomer int64
  • clustersPerEnvironment int64
  • environmentsPerCustomer int64
  • nodePoolsPerCluster int64
  • nodesPerCluster int64
  • nodesPerNodePool int64
                
{
  "properties": {
    "clustersPerCustomer": {
      "format": "int64",
      "type": "integer"
    },
    "clustersPerEnvironment": {
      "format": "int64",
      "type": "integer"
    },
    "environmentsPerCustomer": {
      "format": "int64",
      "type": "integer"
    },
    "nodePoolsPerCluster": {
      "format": "int64",
      "type": "integer"
    },
    "nodesPerCluster": {
      "format": "int64",
      "type": "integer"
    },
    "nodesPerNodePool": {
      "format": "int64",
      "type": "integer"
    }
  },
  "type": "object"
}
                    

Get validations of an organisation.

Path Parameters:

  • organisationSlug
HTTP Responses codes for "Get validations of 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/organisations/{organisationSlug}/validation-status

Response

  • billingEmailVerifiedAt date-time
  • contactEmailVerifiedAt date-time
  • validPaymentMethodAttachedAt date-time
  • vatLegalEntityAddressVerifiedAt date-time
  • vatLegalEntityNameVerifiedAt date-time
  • vatNumberVerificationStatus string
  • vatNumberVerificationUpdatedAt date-time
                
{
  "properties": {
    "billingEmailVerifiedAt": {
      "format": "date-time",
      "type": "string"
    },
    "contactEmailVerifiedAt": {
      "format": "date-time",
      "type": "string"
    },
    "validPaymentMethodAttachedAt": {
      "format": "date-time",
      "type": "string"
    },
    "vatLegalEntityAddressVerifiedAt": {
      "format": "date-time",
      "type": "string"
    },
    "vatLegalEntityNameVerifiedAt": {
      "format": "date-time",
      "type": "string"
    },
    "vatNumberVerificationStatus": {
      "type": "string"
    },
    "vatNumberVerificationUpdatedAt": {
      "format": "date-time",
      "type": "string"
    }
  },
  "type": "object"
}
                    

Get validation status of VAT for an organisation.

Path Parameters:

  • organisationSlug
HTTP Responses codes for "Get validation status of VAT for 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/organisations/{organisationSlug}/validation-status/vat

Response

  • vatLegalEntityAddress string
  • vatLegalEntityName string
                
{
  "properties": {
    "vatLegalEntityAddress": {
      "type": "string"
    },
    "vatLegalEntityName": {
      "type": "string"
    }
  },
  "type": "object"
}
                    

Validate VAT for an organisation.

Path Parameters:

  • organisationSlug
HTTP Responses codes for "Validate VAT for 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
  • vatLegalEntityAddress string
  • vatLegalEntityName string
POST /api/v1/organisations/{organisationSlug}/validation-status/vat

Response

  • billingEmailVerifiedAt date-time
  • contactEmailVerifiedAt date-time
  • validPaymentMethodAttachedAt date-time
  • vatLegalEntityAddressVerifiedAt date-time
  • vatLegalEntityNameVerifiedAt date-time
  • vatNumberVerificationStatus string
  • vatNumberVerificationUpdatedAt date-time
                
{
  "properties": {
    "billingEmailVerifiedAt": {
      "format": "date-time",
      "type": "string"
    },
    "contactEmailVerifiedAt": {
      "format": "date-time",
      "type": "string"
    },
    "validPaymentMethodAttachedAt": {
      "format": "date-time",
      "type": "string"
    },
    "vatLegalEntityAddressVerifiedAt": {
      "format": "date-time",
      "type": "string"
    },
    "vatLegalEntityNameVerifiedAt": {
      "format": "date-time",
      "type": "string"
    },
    "vatNumberVerificationStatus": {
      "type": "string"
    },
    "vatNumberVerificationUpdatedAt": {
      "format": "date-time",
      "type": "string"
    }
  },
  "type": "object"
}
                    

Create an organisation.

HTTP Responses codes for "Create 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
  • acceptedAgreements array Required
    List of #/components/schemas/AcceptAgreementRequest
  • companyAddress string
  • companyName string
  • contactEmail object Required
    One of #/components/schemas/Email
  • organisationName string Required
  • organisationType string Required
  • vatNumber string

Related Objects

AcceptAgreementRequest
  • agreementSlug string
Email
  • email string
Slug
  • slugValue string
POST /api/v1/registration

Response

  • acceptedTerms boolean
  • acceptedTermsAt date-time
  • billingEmail string
  • companyAddress string
  • companyName string
  • contactEmail string
  • createdAt date-time
  • id uuid
  • identity uuid
  • name string
  • phoneNumber string
  • restrictedToAvailableCloudProviders boolean
  • slug object
    One of #/components/schemas/Slug
  • type string
  • vatCode string
  • vatCodeValidated boolean
  • vatCodeValidatedAt date-time
                
{
  "properties": {
    "acceptedTerms": {
      "type": "boolean"
    },
    "acceptedTermsAt": {
      "format": "date-time",
      "type": "string"
    },
    "billingEmail": {
      "type": "string"
    },
    "companyAddress": {
      "type": "string"
    },
    "companyName": {
      "type": "string"
    },
    "contactEmail": {
      "type": "string"
    },
    "createdAt": {
      "format": "date-time",
      "type": "string"
    },
    "id": {
      "deprecated": true,
      "format": "uuid",
      "type": "string"
    },
    "identity": {
      "format": "uuid",
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "phoneNumber": {
      "type": "string"
    },
    "restrictedToAvailableCloudProviders": {
      "type": "boolean"
    },
    "slug": {
      "$ref": "#/components/schemas/Slug"
    },
    "type": {
      "enum": [
        "BUSINESS",
        "ENTERPRISE",
        "INDIVIDUAL",
        "TRIAL"
      ],
      "type": "string"
    },
    "vatCode": {
      "type": "string"
    },
    "vatCodeValidated": {
      "type": "boolean"
    },
    "vatCodeValidatedAt": {
      "format": "date-time",
      "type": "string"
    }
  },
  "type": "object"
}
                    

Verify an e-mail address for an organisation.

Path Parameters:

  • code
HTTP Responses codes for "Verify an e-mail address for 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/validations/verify-email/{code}

Response

  • emailAddress string
                
{
  "properties": {
    "emailAddress": {
      "type": "string"
    }
  },
  "type": "object"
}