Sign in

v1

latestOpenAPI 3.0.32026-07-13218142597.2 KB
Space

Create space

Creates a Space as specified in the payload.

Available on tenants with Role-Based Access Control.

Permissions required: Permission to create spaces.

post/spaces

Request body

namestring required

The name of the space to be created.

keystring

The key for the new space. See Space Keys. If the key property is not provided, the alias property is required to be used instead.

aliasstring

This field will be used as the new identifier for the space in confluence page URLs. If the alias property is not provided, the key property is required to be used instead. Maximum 255 alphanumeric characters in length.

copySpaceAccessConfigurationinteger

The id of the space to copy the space access configuration from.

createPrivateSpaceboolean

Whether to create the space as private.

templateKeystring

The key of the template to use.

Response

Returned if the requested space is created.

idstring

ID of the space.

keystring

Key of the space.

namestring

Name of the space.

type'global' | 'collaboration' | 'knowledge_base' | 'personal' | 'system' | 'onboarding' | 'xflow_sample_space'

The type of space.

status'current' | 'archived'

The status of the space.

authorIdstring

The account ID of the user who created this space originally.

spaceOwnerIdstring

The account ID of the user who owns this space.

currentActiveAliasstring

Currently active alias for a Confluence space.

createdAtstring date-time

Date and time when the space was created. In format "YYYY-MM-DDTHH:mm:ss.sssZ".

homepageIdstring

ID of the space's homepage.