Aller au contenu principal
API docs by Redocly

Numspot Public API (1.0.0)

Download OpenAPI specification:Download

Numspot: support@numspot.com URL: https://numspot.com/contact/ License: BSD 3 Clause Terms of Service

Numspot Public API - /!\ WIP

versions

OpenShift availables versions

List Openshift versions

List all OpenShift versions

Authorizations:
BearerAuth
path Parameters
spaceId
required
string <uuid>

Identifier of the Space

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalSize": 0
}

clusters

A standalone managed OpenShift cluster

List clusters

List all OpenShift clusters

Authorizations:
BearerAuth
path Parameters
spaceId
required
string <uuid>

Identifier of the Space

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalSize": 0
}

Create a cluster

Create an OpenShift cluster

Authorizations:
BearerAuth
path Parameters
spaceId
required
string <uuid>

Identifier of the Space

Request Body schema: application/json
required
cidr
required
string

IP addresses in CIDR notation

description
string
name
required
string^[a-zA-Z0-9-]{3,64}$
required
Array of objects (OpenShift Node Pool)
version
required
string

Responses

Request samples

Content type
application/json
{
  • "cidr": "10.0.0.0/16",
  • "description": "string",
  • "name": "string",
  • "nodePools": [
    ],
  • "version": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "operation": {
    }
}

Delete a cluster

Delete an cluster

Authorizations:
BearerAuth
path Parameters
spaceId
required
string <uuid>

Identifier of the Space

clusterId
required
string

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "operation": {
    }
}

Retrieve a cluster by id

Retrieve a cluster's information by ID

Authorizations:
BearerAuth
path Parameters
spaceId
required
string <uuid>

Identifier of the Space

clusterId
required
string

Responses

Response samples

Content type
application/json
{
  • "cidr": "string",
  • "description": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "nodePools": [
    ],
  • "urls": {
    },
  • "version": "string"
}

Update a cluster

Update an OpenShift cluster

Authorizations:
BearerAuth
path Parameters
spaceId
required
string <uuid>

Identifier of the Space

clusterId
required
string
Request Body schema: application/json
required
description
string
name
string

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "cidr": "string",
  • "description": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "nodePools": [
    ],
  • "urls": {
    },
  • "version": "string"
}

node pools

A OpenShift cluster's node pool

Retrieve cluster's node pools

List node pools of a cluster

Authorizations:
BearerAuth
path Parameters
spaceId
required
string <uuid>

Identifier of the Space

clusterId
required
string

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalSize": 0
}

Create a node pool

Create node pool

Authorizations:
BearerAuth
path Parameters
spaceId
required
string <uuid>

Identifier of the Space

clusterId
required
string
Request Body schema: application/json
required
name
required
string
nodeCount
required
integer
nodeProfile
required
string (NodeProfile)
Enum: "SMALL" "MEDIUM" "LARGE" "VERY_LARGE"

Node profiles

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "nodeCount": 0,
  • "nodeProfile": "SMALL"
}

Response samples

Content type
application/json
{
  • "clusterId": "string",
  • "nodePoolName": "string",
  • "operation": {
    }
}

Delete a node pool

Delete a node pool

Authorizations:
BearerAuth
path Parameters
spaceId
required
string <uuid>

Identifier of the Space

clusterId
required
string
nodePoolName
required
string

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "operation": {
    }
}

workers

A OpenShift cluster's worker

Update a node count for a node pool

Update a nodepool's workers

Authorizations:
BearerAuth
path Parameters
spaceId
required
string <uuid>

Identifier of the Space

clusterId
required
string
nodePoolName
required
string
Request Body schema: application/json
required
count
required
integer

Responses

Request samples

Content type
application/json
{
  • "count": 0
}

Response samples

Content type
application/json
{
  • "clusterId": "string",
  • "nodePoolName": "string",
  • "operation": {
    }
}

operations

A standalone managed OpenShift cluster operation

List operations

List all operations

Authorizations:
BearerAuth
path Parameters
spaceId
required
string <uuid>

Identifier of the Space

query Parameters
status
Array of strings (OperationStatus)
Items Enum: "PENDING" "RUNNING" "DONE" "FAILED"
clusterId
string

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalSize": 0
}

Get an operation by id

Method to get an operation

Authorizations:
BearerAuth
path Parameters
spaceId
required
string <uuid>

Identifier of the Space

id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "createTime": "2019-08-24T14:15:22Z",
  • "data": "string",
  • "endTime": "2019-08-24T14:15:22Z",
  • "error": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "progress": "string",
  • "result": "string",
  • "selfLink": "string",
  • "startTime": "2019-08-24T14:15:22Z",
  • "status": "PENDING",
  • "targetLink": "string",
  • "type": "string"
}

Roles

Role management

ListRolesOrganisation

List roles

Authorizations:
BearerAuth
path Parameters
organisationId
required
string <uuid>

Identifier of the Organisation

query Parameters
name
string <string>

Role name

object

Paginated request

Responses

Response samples

Content type
application/json
{
  • "nextPageToken": "string",
  • "totalSize": -2147483648,
  • "items": [
    ]
}

CreateRoleOrganisation

Create role

Authorizations:
BearerAuth
path Parameters
organisationId
required
string <uuid>

Identifier of the Organisation

Request Body schema: application/json
required

Role

description
required
string

Human-readable description

name
required
string

Human-readable name

Responses

Request samples

Content type
application/json
{
  • "description": "Manage the resourcemanager.storage domain",
  • "name": "Storage Object Admin"
}

Response samples

Content type
application/json
{
  • "description": "Manage the resourcemanager.storage domain",
  • "name": "Storage Object Admin",
  • "createdOn": "2019-08-24T14:15:22Z",
  • "updatedOn": "2019-08-24T14:15:22Z",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

DeleteRoleOrganisation

Delete role

Authorizations:
BearerAuth
path Parameters
organisationId
required
string <uuid>

Identifier of the Organisation

roleUuid
required
string <uuid>

Role ID

Responses

Response samples

Content type
application/problem+json
{}

GetRoleOrganisation

Get role

Authorizations:
BearerAuth
path Parameters
organisationId
required
string <uuid>

Identifier of the Organisation

roleUuid
required
string <uuid>

Role ID

Responses

Response samples

Content type
application/json
{
  • "description": "Manage the resourcemanager.storage domain",
  • "name": "Storage Object Admin",
  • "createdOn": "2019-08-24T14:15:22Z",
  • "updatedOn": "2019-08-24T14:15:22Z",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

UpdateRoleOrganisation

Update role

Authorizations:
BearerAuth
path Parameters
organisationId
required
string <uuid>

Identifier of the Organisation

roleUuid
required
string <uuid>

Role ID

Request Body schema: application/json
required

patch role

description
string

Human-readable description

name
string

Human-readable name

Responses

Request samples

Content type
application/json
{
  • "description": "Manage the resourcemanager.storage domain",
  • "name": "Storage Object Admin"
}

Response samples

Content type
application/problem+json
{
  • "accounts": [
    ],
  • "balance": 30,
  • "detail": "Your current balance is 30, but that costs 50.",
  • "instance": "/account/12345/msgs/abc",
  • "title": "You do not have enough credit.",
  • "type": "https://portal.api.numspot.com/errors#unauthenticated_access",
  • "violations": [
    ]
}

RemoveRolePermissionsOrganisation

Remove permissions from a role

Authorizations:
BearerAuth
path Parameters
organisationId
required
string <uuid>

Identifier of the Organisation

roleUuid
required
string <uuid>

Role ID

Request Body schema: application/json
required

remove role permission request

permissions
required
Array of strings <uuid> [ 1 .. 100 ] items [ items <uuid > ]

List of permissions UUIDs

Responses

Request samples

Content type
application/json
{
  • "permissions": [
    ]
}

Response samples

Content type
application/problem+json
{}

GetRolePermissionsOrganisation

Get a role's permissions

Authorizations:
BearerAuth
path Parameters
organisationId
required
string <uuid>

Identifier of the Organisation

roleUuid
required
string <uuid>

Role ID

Responses

Response samples

Content type
application/json
{
  • "nextPageToken": "string",
  • "totalSize": -2147483648,
  • "items": [
    ]
}

AddRolePermissionsOrganisation

Add permissions to a role

Authorizations:
BearerAuth
path Parameters
organisationId
required
string <uuid>

Identifier of the Organisation

roleUuid
required
string <uuid>

Role ID

Request Body schema: application/json
required

add role permission request

permissions
required
Array of strings <uuid> [ 1 .. 100 ] items [ items <uuid > ]

List of permissions UUIDs

Responses

Request samples

Content type
application/json
{
  • "permissions": [
    ]
}

Response samples

Content type
application/problem+json
{
  • "accounts": [
    ],
  • "balance": 30,
  • "detail": "Your current balance is 30, but that costs 50.",
  • "instance": "/account/12345/msgs/abc",
  • "title": "You do not have enough credit.",
  • "type": "https://portal.api.numspot.com/errors#unauthenticated_access",
  • "violations": [
    ]
}

ListRolesSpace

List roles

Authorizations:
BearerAuth
path Parameters
spaceId
required
string <uuid>

Identifier of the Space

query Parameters
name
string <string>

Role name

object

Paginated request

Responses

Response samples

Content type
application/json
{
  • "nextPageToken": "string",
  • "totalSize": -2147483648,
  • "items": [
    ]
}

CreateRoleSpace

Create role

Authorizations:
BearerAuth
path Parameters
spaceId
required
string <uuid>

Identifier of the Space

Request Body schema: application/json
required

Role

description
required
string

Human-readable description

name
required
string

Human-readable name

Responses

Request samples

Content type
application/json
{
  • "description": "Manage the resourcemanager.storage domain",
  • "name": "Storage Object Admin"
}

Response samples

Content type
application/json
{
  • "description": "Manage the resourcemanager.storage domain",
  • "name": "Storage Object Admin",
  • "createdOn": "2019-08-24T14:15:22Z",
  • "updatedOn": "2019-08-24T14:15:22Z",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

DeleteRoleSpace

Delete role

Authorizations:
BearerAuth
path Parameters
spaceId
required
string <uuid>

Identifier of the Space

roleUuid
required
string <uuid>

Role ID

Responses

Response samples

Content type
application/problem+json
{}

GetRoleSpace

Get role

Authorizations:
BearerAuth
path Parameters
spaceId
required
string <uuid>

Identifier of the Space

roleUuid
required
string <uuid>

Role ID

Responses

Response samples

Content type
application/json
{
  • "description": "Manage the resourcemanager.storage domain",
  • "name": "Storage Object Admin",
  • "createdOn": "2019-08-24T14:15:22Z",
  • "updatedOn": "2019-08-24T14:15:22Z",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

UpdateRoleSpace

Update role

Authorizations:
BearerAuth
path Parameters
spaceId
required
string <uuid>

Identifier of the Space

roleUuid
required
string <uuid>

Role ID

Request Body schema: application/json
required

patch role

description
string

Human-readable description

name
string

Human-readable name

Responses

Request samples

Content type
application/json
{
  • "description": "Manage the resourcemanager.storage domain",
  • "name": "Storage Object Admin"
}

Response samples

Content type
application/problem+json
{
  • "accounts": [
    ],
  • "balance": 30,
  • "detail": "Your current balance is 30, but that costs 50.",
  • "instance": "/account/12345/msgs/abc",
  • "title": "You do not have enough credit.",
  • "type": "https://portal.api.numspot.com/errors#unauthenticated_access",
  • "violations": [
    ]
}

RemoveRolePermissionsSpace

Remove permissions from a role

Authorizations:
BearerAuth
path Parameters
spaceId
required
string <uuid>

Identifier of the Space

roleUuid
required
string <uuid>

Role ID

Request Body schema: application/json
required

remove role permission request

permissions
required
Array of strings <uuid> [ 1 .. 100 ] items [ items <uuid > ]

List of permissions UUIDs

Responses

Request samples

Content type
application/json
{
  • "permissions": [
    ]
}

Response samples

Content type
application/problem+json
{}

GetRolePermissionsSpace

Get a role's permissions

Authorizations:
BearerAuth
path Parameters
spaceId
required
string <uuid>

Identifier of the Space

roleUuid
required
string <uuid>

Role ID

Responses

Response samples

Content type
application/json
{
  • "nextPageToken": "string",
  • "totalSize": -2147483648,
  • "items": [
    ]
}

AddRolePermissionsSpace

Add permissions to a role

Authorizations:
BearerAuth
path Parameters
spaceId
required
string <uuid>

Identifier of the Space

roleUuid
required
string <uuid>

Role ID

Request Body schema: application/json
required

add role permission request

permissions
required
Array of strings <uuid> [ 1 .. 100 ] items [ items <uuid > ]

List of permissions UUIDs

Responses

Request samples

Content type
application/json
{
  • "permissions": [
    ]
}

Response samples

Content type
application/problem+json
{
  • "accounts": [
    ],
  • "balance": 30,
  • "detail": "Your current balance is 30, but that costs 50.",
  • "instance": "/account/12345/msgs/abc",
  • "title": "You do not have enough credit.",
  • "type": "https://portal.api.numspot.com/errors#unauthenticated_access",
  • "violations": [
    ]
}

Permissions

Permission management

ListPermissionsOrganisation

List permissions

Authorizations:
BearerAuth
path Parameters
organisationId
required
string <uuid>

Identifier of the Organisation

query Parameters
service
string
Example: service=storageblock

service the permission is related to

resource
string
Example: resource=bucket

resource the permission is related to

subresource
string
Example: subresource=object

subresource the permission is related to

action
string
Example: action=get

action the permission allows to perform

object

Paginated request

Responses

Response samples

Content type
application/json
{
  • "nextPageToken": "string",
  • "totalSize": -2147483648,
  • "items": [
    ]
}

GetPermissionOrganisation

Get permission

Authorizations:
BearerAuth
path Parameters
organisationId
required
string <uuid>

Identifier of the Organisation

permissionUuid
required
string <uuid>

Permission ID

Responses

Response samples

Content type
application/json
{
  • "action": "delete",
  • "description": "string",
  • "name": "string",
  • "resource": "storage",
  • "service": "resourcemanager",
  • "subResource": "buckets",
  • "createdOn": "2019-08-24T14:15:22Z",
  • "updatedOn": "2019-08-24T14:15:22Z",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

ListPermissionsSpace

List permissions

Authorizations:
BearerAuth
path Parameters
spaceId
required
string <uuid>

Identifier of the Space

query Parameters
service
string
Example: service=storageblock

service the permission is related to

resource
string
Example: resource=bucket

resource the permission is related to

subresource
string
Example: subresource=object

subresource the permission is related to

action
string
Example: action=get

action the permission allows to perform

object

Paginated request

Responses

Response samples

Content type
application/json
{
  • "nextPageToken": "string",
  • "totalSize": -2147483648,
  • "items": [
    ]
}

GetPermissionSpace

Get permission

Authorizations:
BearerAuth
path Parameters
spaceId
required
string <uuid>

Identifier of the Space

permissionUuid
required
string <uuid>

Permission ID

Responses

Response samples

Content type
application/json
{
  • "action": "delete",
  • "description": "string",
  • "name": "string",
  • "resource": "storage",
  • "service": "resourcemanager",
  • "subResource": "buckets",
  • "createdOn": "2019-08-24T14:15:22Z",
  • "updatedOn": "2019-08-24T14:15:22Z",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}

IAMPolicy

Policy management

GetIAMGranularPolicyOrganisation Deprecated

Retrieve the granular policy assigned to a specific subject for a specific object type.

Authorizations:
BearerAuth
path Parameters
organisationId
required
string <uuid>

Identifier of the Organisation

subjectType
required
string (SubjectType)
Enum: "users" "serviceAccounts"

The Type of the Object holding or destined to hold an IAMPolicy

subjectId
required
string <uuid>

Identifier of the subject of the operation.

objectType
required
string

Object Type

Responses

Response samples

Content type
application/json
{
  • "nextPageToken": "string",
  • "totalSize": -2147483648,
  • "items": [
    ]
}

SetIAMGranularPolicyOrganisation Deprecated

Modify the IAM policy by adding or removing granular permissions for a specific object type. If the policy does not exist, it will be implicitly created

Authorizations:
BearerAuth
path Parameters
organisationId
required
string <uuid>

Identifier of the Organisation

subjectType
required
string (SubjectType)
Enum: "users" "serviceAccounts"

The Type of the Object holding or destined to hold an IAMPolicy

subjectId
required
string <uuid>

Identifier of the subject of the operation.

objectType
required
string

Object Type

Request Body schema: application/json
required

Contains details of roles and permissions to be added or deleted from the IAM policy

Array of objects (GranularPolicyList)
Array of objects (GranularPolicyList)

Responses

Request samples

Content type
application/json
{
  • "add": [
    ],
  • "delete": [
    ]
}

Response samples

Content type
application/problem+json
{
  • "accounts": [
    ],
  • "balance": 30,
  • "detail": "Your current balance is 30, but that costs 50.",
  • "instance": "/account/12345/msgs/abc",
  • "title": "You do not have enough credit.",
  • "type": "https://portal.api.numspot.com/errors#unauthenticated_access",
  • "violations": [
    ]
}

GetIAMPolicyOrganisation

Retrieve the policy assigned to a specific subject

Authorizations:
BearerAuth
path Parameters
organisationId
required
string <uuid>

Identifier of the Organisation

subjectType
required
string (SubjectType)
Enum: "users" "serviceAccounts"

The Type of the Object holding or destined to hold an IAMPolicy

subjectId
required
string <uuid>

Identifier of the subject of the operation.

Responses

Response samples

Content type
application/json
{
  • "permissions": [
    ],
  • "roles": [
    ]
}

SetIAMPolicyOrganisation

Modify the IAM policy by adding or removing roles and permissions. If the policy does not exist, it will be implicitly created

Authorizations:
BearerAuth
path Parameters
organisationId
required
string <uuid>

Identifier of the Organisation

subjectType
required
string (SubjectType)
Enum: "users" "serviceAccounts"

The Type of the Object holding or destined to hold an IAMPolicy

subjectId
required
string <uuid>

Identifier of the subject of the operation.

Request Body schema: application/json
required

Contains details of roles and permissions to be added or deleted from the IAM policy

object (IAMPolicy)
object (IAMPolicy)

Responses

Request samples

Content type
application/json
{
  • "add": {
    },
  • "delete": {
    }
}

Response samples

Content type
application/problem+json
{
  • "accounts": [
    ],
  • "balance": 30,
  • "detail": "Your current balance is 30, but that costs 50.",
  • "instance": "/account/12345/msgs/abc",
  • "title": "You do not have enough credit.",
  • "type": "https://portal.api.numspot.com/errors#unauthenticated_access",
  • "violations": [
    ]
}

GetIAMGranularPolicySpace Deprecated

Retrieve the granular policy assigned to a specific subject for a specific object type.

Authorizations:
BearerAuth
path Parameters
spaceId
required
string <uuid>

Identifier of the Space

subjectType
required
string (SubjectType)
Enum: "users" "serviceAccounts"

The Type of the Object holding or destined to hold an IAMPolicy

subjectId
required
string <uuid>

Identifier of the subject of the operation.

objectType
required
string

Object Type

Responses

Response samples

Content type
application/json
{
  • "nextPageToken": "string",
  • "totalSize": -2147483648,
  • "items": [
    ]
}

SetIAMGranularPolicySpace Deprecated

Modify the IAM policy by adding or removing granular permissions for a specific object type. If the policy does not exist, it will be implicitly created

Authorizations:
BearerAuth
path Parameters
spaceId
required
string <uuid>

Identifier of the Space

subjectType
required
string (SubjectType)
Enum: "users" "serviceAccounts"

The Type of the Object holding or destined to hold an IAMPolicy

subjectId
required
string <uuid>

Identifier of the subject of the operation.

objectType
required
string

Object Type

Request Body schema: application/json
required

Contains details of roles and permissions to be added or deleted from the IAM policy

Array of objects (GranularPolicyList)
Array of objects (GranularPolicyList)

Responses

Request samples

Content type
application/json
{
  • "add": [
    ],
  • "delete": [
    ]
}

Response samples

Content type
application/problem+json
{
  • "accounts": [
    ],
  • "balance": 30,
  • "detail": "Your current balance is 30, but that costs 50.",
  • "instance": "/account/12345/msgs/abc",
  • "title": "You do not have enough credit.",
  • "type": "https://portal.api.numspot.com/errors#unauthenticated_access",
  • "violations": [
    ]
}

GetIAMPolicySpace

Retrieve the policy assigned to a specific subject

Authorizations:
BearerAuth
path Parameters
spaceId
required
string <uuid>

Identifier of the Space

subjectType
required
string (SubjectType)
Enum: "users" "serviceAccounts"

The Type of the Object holding or destined to hold an IAMPolicy

subjectId
required
string <uuid>

Identifier of the subject of the operation.

Responses

Response samples

Content type
application/json
{
  • "permissions": [
    ],
  • "roles": [
    ]
}

SetIAMPolicySpace

Modify the IAM policy by adding or removing roles and permissions. If the policy does not exist, it will be implicitly created

Authorizations:
BearerAuth
path Parameters
spaceId
required
string <uuid>

Identifier of the Space

subjectType
required
string (SubjectType)
Enum: "users" "serviceAccounts"

The Type of the Object holding or destined to hold an IAMPolicy

subjectId
required
string <uuid>

Identifier of the subject of the operation.

Request Body schema: application/json
required

Contains details of roles and permissions to be added or deleted from the IAM policy

object (IAMPolicy)
object (IAMPolicy)

Responses

Request samples

Content type
application/json
{
  • "add": {
    },
  • "delete": {
    }
}

Response samples

Content type
application/problem+json
{
  • "accounts": [
    ],
  • "balance": 30,
  • "detail": "Your current balance is 30, but that costs 50.",
  • "instance": "/account/12345/msgs/abc",
  • "title": "You do not have enough credit.",
  • "type": "https://portal.api.numspot.com/errors#unauthenticated_access",
  • "violations": [
    ]
}

ACL

ACL

GetACLServiceAccountOrganisation

Retrieve the ACLs assigned to a specific subject for a specific object type.

Authorizations:
BearerAuth
path Parameters
organisationId
required
string <uuid>

Identifier of the Organisation

serviceAccountId
required
string <uuid>

Service account ID

query Parameters
object

Paginated request

service
required
string
resource
required
string
subresource
string

Responses

Response samples

Content type
application/json
{
  • "nextPageToken": "string",
  • "totalSize": -2147483648,
  • "items": [
    ]
}

DeleteACLServiceAccountOrganisationBulk

delete an ACLs between a subject and a resource.

Authorizations:
BearerAuth
path Parameters
organisationId
required
string <uuid>

Identifier of the Organisation

serviceAccountId
required
string <uuid>

Service account ID

Request Body schema: application/json
required

Contains ACLs to be removed.

required
Array of objects (ACLPaginatedList) [ 1 .. 100 ] items
Array ([ 1 .. 100 ] items)
permissionId
required
string <uuid>

id of the permission

resource
required
string

Type of the resource being accessed

resourceId
required
string

Unique identifier of a resource

service
required
string

Name of the service making the call

subresource
string

Specific type of the subresource within the main resource

Responses

Request samples

Content type
application/json
{
  • "items": [
    ]
}

Response samples

Content type
application/problem+json
{
  • "accounts": [
    ],
  • "balance": 30,
  • "detail": "Your current balance is 30, but that costs 50.",
  • "instance": "/account/12345/msgs/abc",
  • "title": "You do not have enough credit.",
  • "type": "https://portal.api.numspot.com/errors#unauthenticated_access",
  • "violations": [
    ]
}

CreateACLServiceAccountOrganisationBulk

Create an ACLs between a subject and a resource.

Authorizations:
BearerAuth
path Parameters
organisationId
required
string <uuid>

Identifier of the Organisation

serviceAccountId
required
string <uuid>

Service account ID

Request Body schema: application/json
required

Contains ACLs to be added.

required
Array of objects (ACLPaginatedList) [ 1 .. 100 ] items
Array ([ 1 .. 100 ] items)
permissionId
required
string <uuid>

id of the permission

resource
required
string

Type of the resource being accessed

resourceId
required
string

Unique identifier of a resource

service
required
string

Name of the service making the call

subresource
string

Specific type of the subresource within the main resource

Responses

Request samples

Content type
application/json
{
  • "items": [
    ]
}

Response samples

Content type
application/problem+json
{
  • "accounts": [
    ],
  • "balance": 30,
  • "detail": "Your current balance is 30, but that costs 50.",
  • "instance": "/account/12345/msgs/abc",
  • "title": "You do not have enough credit.",
  • "type": "https://portal.api.numspot.com/errors#unauthenticated_access",
  • "violations": [
    ]
}

GetACLUserOrganisation

Retrieve the ACLs assigned to a specific user for a specific object type.

Authorizations:
BearerAuth
path Parameters
organisationId
required
string <uuid>

Identifier of the Organisation

userId
required
string <uuid>

User account ID

query Parameters
object

Paginated request

service
required
string
resource
required
string
subresource
string

Responses

Response samples

Content type
application/json
{
  • "nextPageToken": "string",
  • "totalSize": -2147483648,
  • "items": [
    ]
}

DeleteACLUserOrganisationBulk

delete an ACLs between a subject and a resource.

Authorizations:
BearerAuth
path Parameters
organisationId
required
string <uuid>

Identifier of the Organisation

userId
required
string <uuid>

User account ID

Request Body schema: application/json
required

Contains ACLs to be removed.

required
Array of objects (ACLPaginatedList) [ 1 .. 100 ] items
Array ([ 1 .. 100 ] items)
permissionId
required
string <uuid>

id of the permission

resource
required
string

Type of the resource being accessed

resourceId
required
string

Unique identifier of a resource

service
required
string

Name of the service making the call

subresource
string

Specific type of the subresource within the main resource

Responses

Request samples

Content type
application/json
{
  • "items": [
    ]
}

Response samples

Content type
application/problem+json
{
  • "accounts": [
    ],
  • "balance": 30,
  • "detail": "Your current balance is 30, but that costs 50.",
  • "instance": "/account/12345/msgs/abc",
  • "title": "You do not have enough credit.",
  • "type": "https://portal.api.numspot.com/errors#unauthenticated_access",
  • "violations": [
    ]
}

CreateACLUserOrganisationBulk

Create an ACLs between a subject and a resource.

Authorizations:
BearerAuth
path Parameters
organisationId
required
string <uuid>

Identifier of the Organisation

userId
required
string <uuid>

User account ID

Request Body schema: application/json
required

Contains ACLs to be added.

required
Array of objects (ACLPaginatedList) [ 1 .. 100 ] items
Array ([ 1 .. 100 ] items)
permissionId
required
string <uuid>

id of the permission

resource
required
string

Type of the resource being accessed

resourceId
required
string

Unique identifier of a resource

service
required
string

Name of the service making the call

subresource
string

Specific type of the subresource within the main resource

Responses

Request samples

Content type
application/json
{
  • "items": [
    ]
}

Response samples

Content type
application/problem+json
{
  • "accounts": [
    ],
  • "balance": 30,
  • "detail": "Your current balance is 30, but that costs 50.",
  • "instance": "/account/12345/msgs/abc",
  • "title": "You do not have enough credit.",
  • "type": "https://portal.api.numspot.com/errors#unauthenticated_access",
  • "violations": [
    ]
}

GetACLServiceAccountSpace

Retrieve the ACLs assigned to a specific subject for a specific object type.

Authorizations:
BearerAuth
path Parameters
spaceId
required
string <uuid>

Identifier of the Space

serviceAccountId
required
string <uuid>

Service account ID

query Parameters
object

Paginated request

service
required
string
resource
required
string
subresource
string

Responses

Response samples

Content type
application/json
{
  • "nextPageToken": "string",
  • "totalSize": -2147483648,
  • "items": [
    ]
}

DeleteACLServiceAccountSpaceBulk

delete an ACLs between a subject and a resource.

Authorizations:
BearerAuth
path Parameters
spaceId
required
string <uuid>

Identifier of the Space

serviceAccountId
required
string <uuid>

Service account ID

Request Body schema: application/json
required

Contains ACLs to be removed.

required
Array of objects (ACLPaginatedList) [ 1 .. 100 ] items
Array ([ 1 .. 100 ] items)
permissionId
required
string <uuid>

id of the permission

resource
required
string

Type of the resource being accessed

resourceId
required
string

Unique identifier of a resource

service
required
string

Name of the service making the call

subresource
string

Specific type of the subresource within the main resource

Responses

Request samples

Content type
application/json
{
  • "items": [
    ]
}

Response samples

Content type
application/problem+json
{
  • "accounts": [
    ],
  • "balance": 30,
  • "detail": "Your current balance is 30, but that costs 50.",
  • "instance": "/account/12345/msgs/abc",
  • "title": "You do not have enough credit.",
  • "type": "https://portal.api.numspot.com/errors#unauthenticated_access",
  • "violations": [
    ]
}

CreateACLServiceAccountSpaceBulk

Create an ACLs between a subject and a resource.

Authorizations:
BearerAuth
path Parameters
spaceId
required
string <uuid>

Identifier of the Space

serviceAccountId
required
string <uuid>

Service account ID

Request Body schema: application/json
required

Contains ACLs to be added.

required
Array of objects (ACLPaginatedList) [ 1 .. 100 ] items
Array ([ 1 .. 100 ] items)
permissionId
required
string <uuid>

id of the permission

resource
required
string

Type of the resource being accessed

resourceId
required
string

Unique identifier of a resource

service
required
string

Name of the service making the call

subresource
string

Specific type of the subresource within the main resource

Responses

Request samples

Content type
application/json
{
  • "items": [
    ]
}

Response samples

Content type
application/problem+json
{
  • "accounts": [
    ],
  • "balance": 30,
  • "detail": "Your current balance is 30, but that costs 50.",
  • "instance": "/account/12345/msgs/abc",
  • "title": "You do not have enough credit.",
  • "type": "https://portal.api.numspot.com/errors#unauthenticated_access",
  • "violations": [
    ]
}

GetACLUserSpace

Retrieve the ACLs assigned to a specific subject for a specific object type.

Authorizations:
BearerAuth
path Parameters
spaceId
required
string <uuid>

Identifier of the Space

userId
required
string <uuid>

User account ID

query Parameters
object

Paginated request

service
required
string
resource
required
string
subresource
string

Responses

Response samples

Content type
application/json
{
  • "nextPageToken": "string",
  • "totalSize": -2147483648,
  • "items": [
    ]
}

DeleteACLUserSpaceBulk

delete an ACLs between a subject and a resource.

Authorizations:
BearerAuth
path Parameters
spaceId
required
string <uuid>

Identifier of the Space

userId
required
string <uuid>

User account ID

Request Body schema: application/json
required

Contains ACLs to be removed.

required
Array of objects (ACLPaginatedList) [ 1 .. 100 ] items
Array ([ 1 .. 100 ] items)
permissionId
required
string <uuid>

id of the permission

resource
required
string

Type of the resource being accessed

resourceId
required
string

Unique identifier of a resource

service
required
string

Name of the service making the call

subresource
string

Specific type of the subresource within the main resource

Responses

Request samples

Content type
application/json
{
  • "items": [
    ]
}

Response samples

Content type
application/problem+json
{
  • "accounts": [
    ],
  • "balance": 30,
  • "detail": "Your current balance is 30, but that costs 50.",
  • "instance": "/account/12345/msgs/abc",
  • "title": "You do not have enough credit.",
  • "type": "https://portal.api.numspot.com/errors#unauthenticated_access",
  • "violations": [
    ]
}

CreateACLUserSpaceBulk

Create an ACLs between a subject and a resource.

Authorizations:
BearerAuth
path Parameters
spaceId
required
string <uuid>

Identifier of the Space

userId
required
string <uuid>

User account ID

Request Body schema: application/json
required

Contains ACLs to be added.

required
Array of objects (ACLPaginatedList) [ 1 .. 100 ] items
Array ([ 1 .. 100 ] items)
permissionId
required
string <uuid>

id of the permission

resource
required
string

Type of the resource being accessed

resourceId
required
string

Unique identifier of a resource

service
required
string

Name of the service making the call

subresource
string

Specific type of the subresource within the main resource

Responses

Request samples

Content type
application/json
{
  • "items": [
    ]
}

Response samples

Content type
application/problem+json
{
  • "accounts": [
    ],
  • "balance": 30,
  • "detail": "Your current balance is 30, but that costs 50.",
  • "instance": "/account/12345/msgs/abc",
  • "title": "You do not have enough credit.",
  • "type": "https://portal.api.numspot.com/errors#unauthenticated_access",
  • "violations": [
    ]
}

Oauth2

Token

Generate an access token

header Parameters
Authorization
string

The client identifier.

Request Body schema: application/x-www-form-urlencoded
optional

OAuth2 token request

client_id
string <uuid>

The client id.

client_secret
string

The client secret.

code
string

The code authorization.

grant_type
required
string

The grant type.

redirect_uri
string

The URLs redirection

refresh_token
string

The refresh Token

Responses

Response samples

Content type
application/json
{
  • "access_token": "string",
  • "expires_in": 0,
  • "id_token": "string",
  • "refresh_token": "string",
  • "token_type": "string"
}

Users

ListUserOrganisation

List users or get an existing user by email.

Authorizations:
BearerAuth
path Parameters
organisationId
required
string <uuid>

Identifier of the Organisation

query Parameters
email
string <email>

User email

object

Paginated request

Request Body schema: application/json

A list of Identities Ids

items
required
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
application/json
{
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "nextPageToken": "string",
  • "totalSize": -2147483648,
  • "items": [
    ]
}

CreateUserOrganisation

Create a new user.

Authorizations:
BearerAuth
path Parameters
organisationId
required
string <uuid>

Identifier of the Organisation

Request Body schema: application/json

Create a user

email
required
string <email> (Email)
firstname
required
string

Firstname

lastname
required
string

Lastname

Responses

Request samples

Content type
application/json
{
  • "email": "john.smith@acme.org",
  • "firstname": "string",
  • "lastname": "string"
}

Response samples

Content type
application/json
{
  • "email": "john.smith@acme.org",
  • "firstname": "string",
  • "lastname": "string",
  • "active": true,
  • "createdOn": "2018-11-13T20:20:39+00:00",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

DeleteUserOrganisation

Delete an existing user

Authorizations:
BearerAuth
path Parameters
organisationId
required
string <uuid>

Identifier of the Organisation

userId
required
string <uuid>

User account ID

Responses

Response samples

Content type
application/problem+json
{}

GetUserOrganisation

Retrieve an existing user

Authorizations:
BearerAuth
path Parameters
organisationId
required
string <uuid>

Identifier of the Organisation

userId
required
string <uuid>

User account ID

Responses

Response samples

Content type
application/json
{
  • "email": "john.smith@acme.org",
  • "firstname": "string",
  • "lastname": "string",
  • "active": true,
  • "createdOn": "2018-11-13T20:20:39+00:00",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "updatedOn": "2018-11-13T20:20:39+00:00"
}

PatchUserStateOrganisation

Patch user state within an space.

Authorizations:
BearerAuth
path Parameters
organisationId
required
string <uuid>

Identifier of the Organisation

userId
required
string <uuid>

User account ID

Request Body schema: application/json

Patch user state

active
required
boolean

Account activation/deactivation state

Responses

Request samples

Content type
application/json
{
  • "active": true
}

Response samples

Content type
application/json
{
  • "active": true,
  • "createdOn": "2018-11-13T20:20:39+00:00",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "updatedOn": "2018-11-13T20:20:39+00:00"
}

UpdateUserOrganisation

Update an existing user

Authorizations:
BearerAuth
path Parameters
organisationId
required
string <uuid>

Identifier of the Organisation

userId
required
string <uuid>

User account ID

Request Body schema: application/json

Update a user

email
required
string <email> (Email)
firstname
required
string

Firstname

lastname
required
string

Lastname

active
required
boolean

Account activation/deactivation state

Responses

Request samples

Content type
application/json
{
  • "email": "john.smith@acme.org",
  • "firstname": "string",
  • "lastname": "string",
  • "active": true
}

Response samples

Content type
application/json
{
  • "email": "john.smith@acme.org",
  • "firstname": "string",
  • "lastname": "string",
  • "active": true,
  • "createdOn": "2018-11-13T20:20:39+00:00",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "updatedOn": "2018-11-13T20:20:39+00:00"
}

RecoverUserOrganisation

Generate a recovery link to let the user set his password / totp

Authorizations:
BearerAuth
path Parameters
organisationId
required
string <uuid>

Identifier of the Organisation

userId
required
string <uuid>

User account ID

Responses

Response samples

Content type
application/json
{}

ListSpacesOfUser

Get a list of spaces assigned to a user within an organisation.

Authorizations:
BearerAuth
path Parameters
organisationId
required
string <uuid>

Identifier of the Organisation

userId
required
string <uuid>

User account ID

query Parameters
object

Paginated request

Responses

Response samples

Content type
application/json
{
  • "nextPageToken": "string",
  • "totalSize": -2147483648,
  • "items": [
    ]
}

ListUserSpace

List users or get an existing user by email.

Authorizations:
BearerAuth
path Parameters
spaceId
required
string <uuid>

Identifier of the Space

query Parameters
email
string <email>

User email

object

Paginated request

Request Body schema: application/json

A list of Identities Ids

items
required
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
application/json
{
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "nextPageToken": "string",
  • "totalSize": -2147483648,
  • "items": [
    ]
}

CreateUserSpace

Create a new user.

Authorizations:
BearerAuth
path Parameters
spaceId
required
string <uuid>

Identifier of the Space

Request Body schema: application/json

Create a user

email
required
string <email> (Email)
firstname
required
string

Firstname

lastname
required
string

Lastname

Responses

Request samples

Content type
application/json
{
  • "email": "john.smith@acme.org",
  • "firstname": "string",
  • "lastname": "string"
}

Response samples

Content type
application/json
{
  • "email": "john.smith@acme.org",
  • "firstname": "string",
  • "lastname": "string",
  • "active": true,
  • "createdOn": "2018-11-13T20:20:39+00:00",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

UnassignUserSpace

Unassign an existing user

Authorizations:
BearerAuth
path Parameters
spaceId
required
string <uuid>

Identifier of the Space

userId
required
string <uuid>

User account ID

Responses

Response samples

Content type
application/problem+json
{}

GetUserSpace

Retrieve an existing user

Authorizations:
BearerAuth
path Parameters
spaceId
required
string <uuid>

Identifier of the Space

userId
required
string <uuid>

User account ID

Responses

Response samples

Content type
application/json
{
  • "email": "john.smith@acme.org",
  • "firstname": "string",
  • "lastname": "string",
  • "active": true,
  • "createdOn": "2018-11-13T20:20:39+00:00",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "updatedOn": "2018-11-13T20:20:39+00:00"
}

PatchUserStateSpace

Patch user state within space.

Authorizations:
BearerAuth
path Parameters
spaceId
required
string <uuid>

Identifier of the Space

userId
required
string <uuid>

User account ID

Request Body schema: application/json

Patch user state

active
required
boolean

Account activation/deactivation state

Responses

Request samples

Content type
application/json
{
  • "active": true
}

Response samples

Content type
application/json
{
  • "active": true,
  • "createdOn": "2018-11-13T20:20:39+00:00",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "updatedOn": "2018-11-13T20:20:39+00:00"
}

AssignUserToSpace

Assign a user to a space within an organisation.

Authorizations:
BearerAuth
path Parameters
spaceId
required
string <uuid>

Identifier of the Space

userId
required
string <uuid>

User account ID

Responses

Response samples

Content type
application/problem+json
{
  • "accounts": [
    ],
  • "balance": 30,
  • "detail": "Your current balance is 30, but that costs 50.",
  • "instance": "/account/12345/msgs/abc",
  • "title": "You do not have enough credit.",
  • "type": "https://portal.api.numspot.com/errors#unauthenticated_access",
  • "violations": [
    ]
}

UpdateUserSpace

Update an existing user

Authorizations:
BearerAuth
path Parameters
spaceId
required
string <uuid>

Identifier of the Space

userId
required
string <uuid>

User account ID

Request Body schema: application/json

Update a user

email
required
string <email> (Email)
firstname
required
string

Firstname

lastname
required
string

Lastname

active
required
boolean

Account activation/deactivation state

Responses

Request samples

Content type
application/json
{
  • "email": "john.smith@acme.org",
  • "firstname": "string",
  • "lastname": "string",
  • "active": true
}

Response samples

Content type
application/json
{
  • "email": "john.smith@acme.org",
  • "firstname": "string",
  • "lastname": "string",
  • "active": true,
  • "createdOn": "2018-11-13T20:20:39+00:00",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "updatedOn": "2018-11-13T20:20:39+00:00"
}

RecoverUserSpace

Generate a recovery link to let the user set his password / totp

Authorizations:
BearerAuth
path Parameters
spaceId
required
string <uuid>

Identifier of the Space

userId
required
string <uuid>

User account ID

Responses

Response samples

Content type
application/json
{}

Service Accounts

CreateAdminServiceAccountSpace

Create a new administrator service account.

Authorizations:
BearerAuth
path Parameters
organisationId
required
string <uuid>

Identifier of the Organisation

spaceId
required
string <uuid>

Identifier of the Space

Request Body schema: application/json
required

Create a new service account

name
required
string <string>

Service account name

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "secret": "string"
}

ListServiceAccountOrganisation

List an existing service account.

Authorizations:
BearerAuth
path Parameters
organisationId
required
string <uuid>

Identifier of the Organisation

query Parameters
object

Paginated request

Request Body schema: application/json

A list of Identities Ids

items
required
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
application/json
{
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "nextPageToken": "string",
  • "totalSize": -2147483648,
  • "items": [
    ]
}

CreateServiceAccountOrganisation

Create a new service account.

Authorizations:
BearerAuth
path Parameters
organisationId
required
string <uuid>

Identifier of the Organisation

Request Body schema: application/json
required

Create a new service account

name
required
string <string>

Service account name

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "secret": "string"
}

DeleteServiceAccountOrganisation

Delete an existing service account

Authorizations:
BearerAuth
path Parameters
organisationId
required
string <uuid>

Identifier of the Organisation

serviceAccountId
required
string <uuid>

Service account ID

Responses

Response samples

Content type
application/problem+json
{}

GetServiceAccountOrganisation

Retrieve an existing service account.

Authorizations:
BearerAuth
path Parameters
organisationId
required
string <uuid>

Identifier of the Organisation

serviceAccountId
required
string <uuid>

Service account ID

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

UpdateServiceAccountOrganisation

Update an existing service account.

Authorizations:
BearerAuth
path Parameters
organisationId
required
string <uuid>

Identifier of the Organisation

serviceAccountId
required
string <uuid>

Service account ID

Request Body schema: application/json

Update a service account

name
required
string <string>

Service account name

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

ListSpacesOfServiceAccount

Get a list of spaces assigned to a service account within an organisation.

Authorizations:
BearerAuth
path Parameters
organisationId
required
string <uuid>

Identifier of the Organisation

serviceAccountId
required
string <uuid>

Service account ID

query Parameters
object

Paginated request

Responses

Response samples

Content type
application/json
{
  • "nextPageToken": "string",
  • "totalSize": -2147483648,
  • "items": [
    ]
}

ListServiceAccountSpace

List an existing service account.

Authorizations:
BearerAuth
path Parameters
spaceId
required
string <uuid>

Identifier of the Space

query Parameters
object

Paginated request

Request Body schema: application/json

A list of Identities Ids

items
required
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
application/json
{
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "nextPageToken": "string",
  • "totalSize": -2147483648,
  • "items": [
    ]
}

CreateServiceAccountSpace

Create a new service account.

Authorizations:
BearerAuth
path Parameters
spaceId
required
string <uuid>

Identifier of the Space

Request Body schema: application/json
required

Create a new service account

name
required
string <string>

Service account name

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "secret": "string"
}

DeleteServiceAccountSpace

Delete an existing service account

Authorizations:
BearerAuth
path Parameters
spaceId
required
string <uuid>

Identifier of the Space

serviceAccountId
required
string <uuid>

Service account ID

Responses

Response samples

Content type
application/problem+json
{}

GetServiceAccountSpace

Retrieve an existing service account.

Authorizations:
BearerAuth
path Parameters
spaceId
required
string <uuid>

Identifier of the Space

serviceAccountId
required
string <uuid>

Service account ID

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

AssignServiceAccountToSpace

Assign a service account to a space within an organisation.

Authorizations:
BearerAuth
path Parameters
spaceId
required
string <uuid>

Identifier of the Space

serviceAccountId
required
string <uuid>

Service account ID

Responses

Response samples

Content type
application/problem+json
{
  • "accounts": [
    ],
  • "balance": 30,
  • "detail": "Your current balance is 30, but that costs 50.",
  • "instance": "/account/12345/msgs/abc",
  • "title": "You do not have enough credit.",
  • "type": "https://portal.api.numspot.com/errors#unauthenticated_access",
  • "violations": [
    ]
}

UpdateServiceAccountSpace

Update an existing service account.

Authorizations:
BearerAuth
path Parameters
spaceId
required
string <uuid>

Identifier of the Space

serviceAccountId
required
string <uuid>

Service account ID

Request Body schema: application/json

Update a service account

name
required
string <string>

Service account name

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

Identity

ListOrganisationsIdentity

Get a list of organisations assigned to an identity.

Authorizations:
BearerAuth
query Parameters
object

Paginated request

Responses

Response samples

Content type
application/json
{
  • "nextPageToken": "string",
  • "totalSize": -2147483648,
  • "items": [
    ]
}

ListSpacesIdentity

Get a list of spaces assigned to an identity within an organisation.

Authorizations:
BearerAuth
path Parameters
organisationId
required
string <uuid>

Identifier of the Organisation

query Parameters
object

Paginated request

Responses

Response samples

Content type
application/json
{
  • "nextPageToken": "string",
  • "totalSize": -2147483648,
  • "items": [
    ]
}

Organisations

Manage Organisations

Spaces

Manage Spaces

ListSpaces

List spaces

Authorizations:
BearerAuth
path Parameters
organisationId
required
string <uuid>

Identifier of the Organisation

query Parameters
object

list spaces paginated request

Request Body schema: application/json

A list of Spaces Ids

items
required
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
application/json
{
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "nextPageToken": "string",
  • "totalSize": -2147483648,
  • "items": [
    ]
}

CreateSpace

Create Space

Authorizations:
BearerAuth
path Parameters
organisationId
required
string <uuid>

Identifier of the Organisation

Request Body schema: application/json
required

Space

description
required
string <string> [ 1 .. 300 ] characters

Space description

name
required
string <string> [ 1 .. 50 ] characters

Space name

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "name": "string",
  • "createdOn": "2018-11-13T20:20:39+00:00",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organisationId": "c9b3f279-e3b5-4204-ad99-646257417f98",
  • "status": "QUEUED",
  • "updatedOn": "2018-11-13T20:20:39+00:00"
}

DeleteSpace

Delete Space

Authorizations:
BearerAuth
path Parameters
organisationId
required
string <uuid>

Identifier of the Organisation

spaceId
required
string <uuid>

Identifier of the Space

Responses

Response samples

Content type
application/problem+json
{}

GetSpaceById

Get Space

Authorizations:
BearerAuth
path Parameters
organisationId
required
string <uuid>

Identifier of the Organisation

spaceId
required
string <uuid>

Identifier of the Space

Responses

Response samples

Content type
application/json
{
  • "description": "string",
  • "name": "string",
  • "createdOn": "2018-11-13T20:20:39+00:00",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organisationId": "c9b3f279-e3b5-4204-ad99-646257417f98",
  • "status": "QUEUED",
  • "updatedOn": "2018-11-13T20:20:39+00:00"
}

UpdateSpace

Partially update a space

Authorizations:
BearerAuth
path Parameters
organisationId
required
string <uuid>

Identifier of the Organisation

spaceId
required
string <uuid>

Identifier of the Space

Request Body schema: application/json
required

Space

description
string <string> [ 1 .. 300 ] characters

Space description

name
string <string> [ 1 .. 50 ] characters

Space name

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "name": "string"
}

Response samples

Content type
application/problem+json
{
  • "accounts": [
    ],
  • "balance": 30,
  • "detail": "Your current balance is 30, but that costs 50.",
  • "instance": "/account/12345/msgs/abc",
  • "title": "You do not have enough credit.",
  • "type": "https://portal.api.numspot.com/errors#unauthenticated_access",
  • "violations": [
    ]
}