Skip to content

Create Map

POST
/v1/sandbox/{sandbox_id}/map

Add a new Map for a sandbox

Requires permission sandbox:config:edit.

Authorizations

Parameters

Path Parameters

sandbox_id
required

Sandbox ID

string format: uuid

Sandbox ID

Request Body required

This mixin is meant to give a set of common properties to root config models

object
custom_data

Custom data associated with the resource

object
key
additional properties
string
name

Name of the resource

string
>= 1 characters <= 125 characters
description

Description of the resource

string
>= 1 characters <= 250 characters
map_name
required

The name of the map that will be loaded into

string
>= 1 characters <= 4096 characters
mode
required

An optional mode that will be loaded into

string
>= 1 characters <= 4096 characters
misc_params

Additional commandline parameters for the instance

string
>= 1 characters <= 4096 characters
legacy_config

Old config used by Legacy systems. These values are ignored by the current APIs

object
map_id

Old map id

integer

Responses

200

Successful Response

This mixin is meant to give a set of common properties to root config models

object
custom_data

Custom data associated with the resource

object
key
additional properties
string
name

Name of the resource

string
>= 1 characters <= 125 characters
description

Description of the resource

string
>= 1 characters <= 250 characters
map_name
required

The name of the map that will be loaded into

string
>= 1 characters <= 4096 characters
mode
required

An optional mode that will be loaded into

string
>= 1 characters <= 4096 characters
misc_params

Additional commandline parameters for the instance

string
>= 1 characters <= 4096 characters
legacy_config

Old config used by Legacy systems. These values are ignored by the current APIs

object
map_id

Old map id

integer
sandbox_id

ID of the Sandbox

string format: uuid
last_modified_account_id

Account ID of the user who last modified the resource

string format: uuid
last_modified_timestamp

Timestamp of when the resource was last modified

string format: date-time
created_timestamp

Timestamp of when this resource was created

string format: date-time
map_id
required

ID to uniquely identify this Map

string format: uuid

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string