Interface SpaceCreate

This is the request object used when creating a new space.

interface SpaceCreate {
    alias?: string;
    description?: null | SpaceDescriptionCreate;
    key?: string;
    name: string;
    permissions?: null | SpacePermissionCreate[];
}

Hierarchy

  • Record<string, unknown>
    • SpaceCreate

Properties

alias? description? key? name permissions?

Properties

Optionalalias

alias?: string

This field will be used as the new identifier for the space in confluence page URLs. If the property is not provided the alias will be the provided key. This property is experimental and may be changed or removed in the future.

Optionaldescription

description?: null | SpaceDescriptionCreate

The description of the new/updated space. Note, only the 'plain' representation can be used for the description when creating or updating a space.

Optionalkey

key?: string

The key for the new space. Format: See Space keys. If alias is not provided, this is required.

name

name: string

The name of the new space.

Optionalpermissions

permissions?: null | SpacePermissionCreate[]

The permissions for the new space. If no permissions are provided, the Confluence default space permissions are applied. Note that if permissions are provided, the space is created with only the provided set of permissions, not including the default space permissions. Space permissions can be modified after creation using the space permissions endpoints, and a private space can be created using the create private space endpoint.

Settings

Member Visibility

On This Page

Properties