Skip to main content
API docs by Redocly

Public Space Blocks Core API (v1)

Download OpenAPI specification:Download

This is the public API.

Client

GetAllClients

Authorizations:
Bearer

Responses

Response samples

Content type
No sample

CreateClient

Authorizations:
Bearer
Request Body schema:
name
string
spaceBlockSlugs
Array of strings unique
redirectUris
Array of strings unique
scopes
Array of strings unique
projectId
string
environmentId
string

Responses

Request samples

Content type
No sample

Response samples

Content type
No sample

GetClient

Authorizations:
Bearer
path Parameters
clientId
required
string

Responses

Response samples

Content type
No sample

DeleteClient

Authorizations:
Bearer
path Parameters
clientId
required
string

Responses

DataCenter

GetAll

Authorizations:
Bearer

Responses

Response samples

Content type
No sample

GetById

Authorizations:
Bearer
path Parameters
id
required
string

Responses

Response samples

Content type
No sample

Environment

Get

Authorizations:
Bearer
path Parameters
projectId
required
string

Responses

Response samples

Content type
No sample

Create

Authorizations:
Bearer
path Parameters
projectId
required
string
Request Body schema:
name
string
dataCenterId
string
tier
integer <int32> (EnvironmentTier)
Enum: 0 1 2

Responses

Request samples

Content type
No sample

Response samples

Content type
No sample

GetEnvironment

Authorizations:
Bearer
path Parameters
environmentId
required
string
projectId
required
string

Responses

Response samples

Content type
No sample

Delete

Authorizations:
Bearer
path Parameters
environmentId
required
string
projectId
required
string

Responses

RegenerateApiKey

Authorizations:
Bearer
path Parameters
environmentId
required
string
projectId
required
string

Responses

Response samples

Content type
No sample

GetApiKey

Authorizations:
Bearer
path Parameters
environmentId
required
string
projectId
required
string

Responses

Response samples

Content type
No sample

Updates the metadata for a specific Space Block in an Environment.

Authorizations:
Bearer
path Parameters
id
required
string

Space Blocks Environment ID

spaceBlockSlug
required
string

The Slug of the Space Block you want to store Metadata for.

projectId
required
string
Request Body schema:

The JSON Metadata you want to store.

any

Responses

Request samples

Content type
No sample

Project

GetAllProjects

Authorizations:
Bearer

Responses

Response samples

Content type
No sample

CreateProject

Authorizations:
Bearer
Request Body schema:
name
string
spaceBlocks
Array of strings unique
template
string or null

Responses

Request samples

Content type
No sample

Response samples

Content type
No sample

GetProject

Authorizations:
Bearer
path Parameters
projectId
required
string

Responses

Response samples

Content type
No sample

UpdateProject

Authorizations:
Bearer
path Parameters
projectId
required
string
Request Body schema:
name
string

Responses

Request samples

Content type
No sample

Response samples

Content type
No sample

DeleteProject

Authorizations:
Bearer
path Parameters
projectId
required
string

Responses

AddSpaceBlockToProject

Authorizations:
Bearer
path Parameters
projectId
required
string
Request Body schema:
spaceBlock
string

Responses

Request samples

Content type
No sample

Response samples

Content type
No sample

RemoveSpaceBlockFromProject

Authorizations:
Bearer
path Parameters
projectId
required
string
spaceBlock
required
string

Responses

Response samples

Content type
No sample

SpaceBlock

GetAll

Authorizations:
Bearer

Responses

Response samples

Content type
No sample

Tenant

GetCurrentTenant

Authorizations:
Bearer

Responses

Response samples

Content type
No sample