Organisations
On this page
- Get accumulated compute information for an organisation.
- Create an organisation.
- Delete an organisation (only possible if the organisation has no configured cloud accounts, no active clusters and no active monitoring tenants).
- Get an organisation.
- Update organisation settings.
- GET /api/v1/organisations/{organisationSlug}/activity
- Get the membership in an organisation for the user requesting this endpoint.
- List members in an organisation.
- Add a member to an organisation.
- Delete a member from an organisation.
- Get quotas for an organisation.
- Get validations of an organisation.
- Get validation status of VAT for an organisation.
- Validate VAT for an organisation.
- Create an organisation.
- Verify an e-mail address for an organisation.
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 Code | Description |
---|---|
200 | Request was successfully processed. The response body contains the requested data. |
400 | Invalid request parameters. Please review the documentation for valid parameter values. |
403 | You do not have the necessary permissions to access this resource. |
404 | The requested resource could not be found. Please check the resource URL or identifier. |
500 | An internal error occurred on the server. |
GET /api/v1/compute-information/organisation/{organisationSlug}
Response
totalClusters
int64totalCpu
int64totalMemory
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 Code | Description |
---|---|
200 | Request was successfully processed. The response body contains the requested data. |
400 | Invalid request parameters. Please review the documentation for valid parameter values. |
403 | You do not have the necessary permissions to access this resource. |
404 | The requested resource could not be found. Please check the resource URL or identifier. |
500 | An internal error occurred on the server. |
Request Body Parameters
acceptedAgreements
array RequiredList of#/components/schemas/AcceptAgreementRequest
companyAddress
stringmax length: 255
companyName
stringmax length: 255
contactEmail
object RequiredOne of#/components/schemas/Email
organisationName
string Requiredmin length: 3
max length: 30
organisationType
string RequiredOne ofBUSINESS
ENTERPRISE
INDIVIDUAL
TRIAL
vatNumber
stringmax length: 255
Related Objects
AcceptAgreementRequest
agreementSlug
string
email
string
Slug
slugValue
string
POST /api/v1/organisations
Response
acceptedTerms
booleanacceptedTermsAt
date-timebillingEmail
stringcompanyAddress
stringcompanyName
stringcontactEmail
stringcreatedAt
date-timehasStripeCustomer
booleanid
uuididentity
uuidname
stringphoneNumber
stringrestrictedToAvailableCloudProviders
booleanslug
objectOne of#/components/schemas/Slug
type
stringvatCode
stringvatCodeValidated
booleanvatCodeValidatedAt
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" }, "hasStripeCustomer": { "type": "boolean" }, "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 Code | Description |
---|---|
204 | Request was successfully processed, but there is no response body to return. |
400 | Invalid request parameters. Please review the documentation for valid parameter values. |
403 | You do not have the necessary permissions to access this resource. |
404 | The requested resource could not be found. Please check the resource URL or identifier. |
500 | An 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 Code | Description |
---|---|
200 | Request was successfully processed. The response body contains the requested data. |
400 | Invalid request parameters. Please review the documentation for valid parameter values. |
403 | You do not have the necessary permissions to access this resource. |
404 | The requested resource could not be found. Please check the resource URL or identifier. |
500 | An internal error occurred on the server. |
Related Objects
Slug
slugValue
string
GET /api/v1/organisations/{organisationSlug}
Response
acceptedTerms
booleanacceptedTermsAt
date-timebillingEmail
stringcompanyAddress
stringcompanyName
stringcontactEmail
stringcreatedAt
date-timehasStripeCustomer
booleanid
uuididentity
uuidname
stringphoneNumber
stringrestrictedToAvailableCloudProviders
booleanslug
objectOne of#/components/schemas/Slug
type
stringvatCode
stringvatCodeValidated
booleanvatCodeValidatedAt
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" }, "hasStripeCustomer": { "type": "boolean" }, "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 Code | Description |
---|---|
200 | Request was successfully processed. The response body contains the requested data. |
400 | Invalid request parameters. Please review the documentation for valid parameter values. |
403 | You do not have the necessary permissions to access this resource. |
404 | The requested resource could not be found. Please check the resource URL or identifier. |
500 | An internal error occurred on the server. |
Request Body Parameters
billingEmail
objectOne of#/components/schemas/Email
contactEmail
objectOne of#/components/schemas/Email
organisationName
stringorganisationType
stringvatNumber
string
Related Objects
email
string
Slug
slugValue
string
PATCH /api/v1/organisations/{organisationSlug}
Response
acceptedTerms
booleanacceptedTermsAt
date-timebillingEmail
stringcompanyAddress
stringcompanyName
stringcontactEmail
stringcreatedAt
date-timehasStripeCustomer
booleanid
uuididentity
uuidname
stringphoneNumber
stringrestrictedToAvailableCloudProviders
booleanslug
objectOne of#/components/schemas/Slug
type
stringvatCode
stringvatCodeValidated
booleanvatCodeValidatedAt
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" }, "hasStripeCustomer": { "type": "boolean" }, "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 Code | Description |
---|---|
200 | OK |
400 | Invalid request parameters. Please review the documentation for valid parameter values. |
403 | You do not have the necessary permissions to access this resource. |
404 | The requested resource could not be found. Please check the resource URL or identifier. |
500 | An internal error occurred on the server. |
Related Objects
ActivityEventResponse
actor
objectOne of#/components/schemas/ActivityEventActor
createdAt
date-timemessage
stringtype
string
PageableObject
offset
int64pageNumber
int32pageSize
int32paged
booleansort
arrayList of#/components/schemas/SortObject
unpaged
boolean
SortObject
ascending
booleandirection
stringignoreCase
booleannullHandling
stringproperty
string
GET /api/v1/organisations/{organisationSlug}/activity
Response
content
arrayList of#/components/schemas/ActivityEventResponse
empty
booleanfirst
booleanlast
booleannumber
int32numberOfElements
int32pageable
objectOne of#/components/schemas/PageableObject
size
int32sort
arrayList of#/components/schemas/SortObject
totalElements
int64totalPages
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": { "items": { "$ref": "#/components/schemas/SortObject" }, "type": "array" }, "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 Code | Description |
---|---|
200 | Request was successfully processed. The response body contains the requested data. |
400 | Invalid request parameters. Please review the documentation for valid parameter values. |
403 | You do not have the necessary permissions to access this resource. |
404 | The requested resource could not be found. Please check the resource URL or identifier. |
500 | An internal error occurred on the server. |
Related Objects
email
string
GET /api/v1/organisations/{organisationSlug}/me
Response
email
objectOne of#/components/schemas/Email
identity
uuidjoinedAt
date-timekubernetesRole
stringrole
stringsubject
uuidusername
string
{ "properties": { "email": { "$ref": "#/components/schemas/Email" }, "identity": { "format": "uuid", "type": "string" }, "joinedAt": { "format": "date-time", "type": "string" }, "kubernetesRole": { "enum": [ "cluster-admin", "edit", "view", "" ], "type": "string" }, "role": { "enum": [ "admin", "developer", "billing-admin", "viewer" ], "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 Code | Description |
---|---|
200 | Request was successfully processed. The response body contains the requested data. |
400 | Invalid request parameters. Please review the documentation for valid parameter values. |
403 | You do not have the necessary permissions to access this resource. |
404 | The requested resource could not be found. Please check the resource URL or identifier. |
500 | An internal error occurred on the server. |
Related Objects
OrganisationMemberResponse
email
objectOne of#/components/schemas/Email
identity
uuidjoinedAt
date-timekubernetesRole
stringOne ofcluster-admin
edit
view
role
stringOne ofadmin
developer
billing-admin
viewer
subject
uuidusername
string
PageableObject
offset
int64pageNumber
int32pageSize
int32paged
booleansort
arrayList of#/components/schemas/SortObject
unpaged
boolean
SortObject
ascending
booleandirection
stringignoreCase
booleannullHandling
stringproperty
string
GET /api/v1/organisations/{organisationSlug}/members
Response
content
arrayList of#/components/schemas/OrganisationMemberResponse
empty
booleanfirst
booleanlast
booleannumber
int32numberOfElements
int32pageable
objectOne of#/components/schemas/PageableObject
size
int32sort
arrayList of#/components/schemas/SortObject
totalElements
int64totalPages
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": { "items": { "$ref": "#/components/schemas/SortObject" }, "type": "array" }, "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 Code | Description |
---|---|
200 | Request was successfully processed. The response body contains the requested data. |
400 | Invalid request parameters. Please review the documentation for valid parameter values. |
403 | You do not have the necessary permissions to access this resource. |
404 | The requested resource could not be found. Please check the resource URL or identifier. |
500 | An internal error occurred on the server. |
Request Body Parameters
email
objectOne of#/components/schemas/Email
kubernetesRole
stringOne ofcluster-admin
edit
view
role
stringOne ofadmin
developer
billing-admin
viewer
username
stringmax length: 255
Related Objects
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 Code | Description |
---|---|
204 | Request was successfully processed, but there is no response body to return. |
400 | Invalid request parameters. Please review the documentation for valid parameter values. |
403 | You do not have the necessary permissions to access this resource. |
404 | The requested resource could not be found. Please check the resource URL or identifier. |
500 | An 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 Code | Description |
---|---|
200 | Request was successfully processed. The response body contains the requested data. |
400 | Invalid request parameters. Please review the documentation for valid parameter values. |
403 | You do not have the necessary permissions to access this resource. |
404 | The requested resource could not be found. Please check the resource URL or identifier. |
500 | An internal error occurred on the server. |
GET /api/v1/organisations/{organisationSlug}/quotas
Response
clustersPerCustomer
int64clustersPerEnvironment
int64environmentsPerCustomer
int64nodePoolsPerCluster
int64nodesPerCluster
int64nodesPerNodePool
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 Code | Description |
---|---|
200 | Request was successfully processed. The response body contains the requested data. |
400 | Invalid request parameters. Please review the documentation for valid parameter values. |
403 | You do not have the necessary permissions to access this resource. |
404 | The requested resource could not be found. Please check the resource URL or identifier. |
500 | An internal error occurred on the server. |
GET /api/v1/organisations/{organisationSlug}/validation-status
Response
billingEmailVerifiedAt
date-timecontactEmailVerifiedAt
date-timevalidPaymentMethodAttachedAt
date-timevatLegalEntityAddressVerifiedAt
date-timevatLegalEntityNameVerifiedAt
date-timevatNumberVerificationStatus
stringvatNumberVerificationUpdatedAt
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 Code | Description |
---|---|
200 | Request was successfully processed. The response body contains the requested data. |
400 | Invalid request parameters. Please review the documentation for valid parameter values. |
403 | You do not have the necessary permissions to access this resource. |
404 | The requested resource could not be found. Please check the resource URL or identifier. |
500 | An internal error occurred on the server. |
GET /api/v1/organisations/{organisationSlug}/validation-status/vat
Response
vatLegalEntityAddress
stringvatLegalEntityName
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 Code | Description |
---|---|
200 | Request was successfully processed. The response body contains the requested data. |
400 | Invalid request parameters. Please review the documentation for valid parameter values. |
403 | You do not have the necessary permissions to access this resource. |
404 | The requested resource could not be found. Please check the resource URL or identifier. |
500 | An internal error occurred on the server. |
Request Body Parameters
vatLegalEntityAddress
stringvatLegalEntityName
string
POST /api/v1/organisations/{organisationSlug}/validation-status/vat
Response
billingEmailVerifiedAt
date-timecontactEmailVerifiedAt
date-timevalidPaymentMethodAttachedAt
date-timevatLegalEntityAddressVerifiedAt
date-timevatLegalEntityNameVerifiedAt
date-timevatNumberVerificationStatus
stringvatNumberVerificationUpdatedAt
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 Code | Description |
---|---|
200 | Request was successfully processed. The response body contains the requested data. |
400 | Invalid request parameters. Please review the documentation for valid parameter values. |
403 | You do not have the necessary permissions to access this resource. |
404 | The requested resource could not be found. Please check the resource URL or identifier. |
500 | An internal error occurred on the server. |
Request Body Parameters
acceptedAgreements
array RequiredList of#/components/schemas/AcceptAgreementRequest
companyAddress
stringmax length: 255
companyName
stringmax length: 255
contactEmail
object RequiredOne of#/components/schemas/Email
organisationName
string Requiredmin length: 3
max length: 30
organisationType
string RequiredOne ofBUSINESS
ENTERPRISE
INDIVIDUAL
TRIAL
vatNumber
stringmax length: 255
Related Objects
AcceptAgreementRequest
agreementSlug
string
email
string
Slug
slugValue
string
POST /api/v1/registration
Response
acceptedTerms
booleanacceptedTermsAt
date-timebillingEmail
stringcompanyAddress
stringcompanyName
stringcontactEmail
stringcreatedAt
date-timehasStripeCustomer
booleanid
uuididentity
uuidname
stringphoneNumber
stringrestrictedToAvailableCloudProviders
booleanslug
objectOne of#/components/schemas/Slug
type
stringvatCode
stringvatCodeValidated
booleanvatCodeValidatedAt
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" }, "hasStripeCustomer": { "type": "boolean" }, "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 Code | Description |
---|---|
200 | Request was successfully processed. The response body contains the requested data. |
400 | Invalid request parameters. Please review the documentation for valid parameter values. |
403 | You do not have the necessary permissions to access this resource. |
404 | The requested resource could not be found. Please check the resource URL or identifier. |
500 | An internal error occurred on the server. |
GET /api/v1/validations/verify-email/{code}
Response
emailAddress
string
{ "properties": { "emailAddress": { "type": "string" } }, "type": "object" }