Skip to main content

Create Setting Type

POST 
/v1/sandbox/:sandbox_id/setting-type

Create custom Setting Type for a sandbox Requires permission sandbox:config:edit.

Request​

Path Parameters

    sandbox_id uuidrequired

    Sandbox ID

Body

required

    name Name (string)

    Possible values: non-empty and <= 125 characters

    Name of the resource

    description Description (string)

    Possible values: <= 250 characters

    Description of the resource

    custom_data

    object

    Custom data associated with the resource

    property name* string
    setting_type_unique_id uuid

    Unique identifier for this setting type

    version Version (integer)

    Default value: 1

    Version of setting type schema

    value_jsonschema object

    Default value: [object Object]

    JSONSchema definition of the setting

    allow_update Allow Update (boolean)

    Default value: true

    Whether setting type can be updated

    key_regex Key Regex (string)

    Default value: ^.+$

    Regex that is used to verify keys at assignment time

    type Type (string)required

    User friendly identifier of setting type

Responses​

Successful Response

Schema

    custom_data

    object

    Custom data associated with the resource

    property name* string
    name Name (string)

    Possible values: non-empty and <= 125 characters

    Name of the resource

    description Description (string)

    Possible values: <= 250 characters

    Description of the resource

    last_modified_account_id uuid

    Account ID of the user who last modified the resource

    last_modified_timestamp date-time

    Timestamp of when the resource was last modified

    created_timestamp date-time

    Timestamp of when the resource was created

    setting_type_unique_id uuidrequired

    Unique identifier for this setting type

    type Type (string)required

    User friendly identifier of setting type

    version Version (integer)

    Default value: 1

    Version of setting type schema

    value_jsonschema object

    Default value: [object Object]

    JSONSchema definition of the setting

    allow_update Allow Update (boolean)

    Default value: true

    Whether setting type can be updated

    key_regex Key Regex (string)

    Default value: ^.+$

    Regex that is used to verify keys at assignment time

Loading...