Skip to content

Get All Maps

GET
/v1/sandbox/{sandbox_id}/map

Get all Maps for a sandbox

Requires any of permissions: sandbox:config:view, sandbox:config:edit

Authorizations

Parameters

Path Parameters

sandbox_id
required

Sandbox ID

string format: uuid

Sandbox ID

Query Parameters

page_size

The maximum number of elements to be returned per call

integer
default: 50 >= 1 <= 10000

The maximum number of elements to be returned per call

cursor

Cursor to designate where you are in iterating through values. Start with ‘0’, and pass this on subsequent calls to continue iteration

string
default: 0 >= 1 characters <= 128 characters

Cursor to designate where you are in iterating through values. Start with '0', and pass this on subsequent calls to continue iteration

Responses

200

Successful Response

object
cursor
required

Cursor to designate where you are in iterating through values. Start with ‘0’, and pass this on subsequent calls to continue iteration

string
>= 1 characters <= 128 characters
maps

List of Maps

Array<object>
default:

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 <= 1024 characters
mode

An optional mode that will be loaded into

string
>= 1 characters <= 1024 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