Confluence.js - Cloud and Server API library
    Preparing search index...

    Interface SpaceCreate

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

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

    Hierarchy (View Summary)

    Index

    Properties

    alias? description? key? name permissions?

    Properties

    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.

    description?: SpaceDescriptionCreate
    key?: string

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

    name: string

    The name of the new space.

    permissions?: SpacePermission[]

    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