Create Map

POST 
/v1/sandbox/:sandbox_id/map

Add a new Map for a sandbox

Requires permission sandbox:config:edit.

Request

Path Parameters

sandbox_id uuidrequired

Sandbox ID

application/json

Body

required

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

map_name Map Name (string)required

Possible values: non-empty and <= 1024 characters

The name of the map that will be loaded into

mode Mode (string)

Possible values: non-empty and <= 1024 characters

An optional mode that will be loaded into

misc_params Misc Params (string)

Possible values: non-empty and <= 4096 characters

Additional commandline parameters for the instance

legacy_config

object

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

map_id Map Id (integer)

Default value: 0

Old map id

Responses

200

Successful Response

application/json

Schema

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

map_name Map Name (string)required

Possible values: non-empty and <= 1024 characters

The name of the map that will be loaded into

mode Mode (string)

Possible values: non-empty and <= 1024 characters

An optional mode that will be loaded into

misc_params Misc Params (string)

Possible values: non-empty and <= 4096 characters

Additional commandline parameters for the instance

legacy_config

object

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

map_id Map Id (integer)

Default value: 0

Old map id

sandbox_id uuid

ID of the Sandbox

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 this resource was created

map_id uuidrequired

ID to uniquely identify this Map

Example (from schema)

{
  "custom_data": {},
  "name": "string",
  "description": "string",
  "map_name": "string",
  "mode": "string",
  "misc_params": "string",
  "legacy_config": {
    "map_id": 0
  },
  "sandbox_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "last_modified_account_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "last_modified_timestamp": "2024-07-29T15:51:28.071Z",
  "created_timestamp": "2024-07-29T15:51:28.071Z",
  "map_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...