Get Partition

GET 
/v1/sandbox/:sandbox_id/crossplay-partition/:crossplay_partition_id

Get a specific CrossplayPartition for a sandbox

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

Request

Path Parameters

crossplay_partition_id uuidrequired
sandbox_id uuidrequired

Sandbox ID

Responses

200

Successful Response

application/json

Schema

Schema

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
enabled Enabled (boolean)

Default value: true

Whether or not this partition is enabled and can be used

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

crossplay_partition_id uuidrequired

ID to uniquely identify this CrossplayPartition

Example (from schema)

{
  "name": "string",
  "description": "string",
  "custom_data": {},
  "enabled": true,
  "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",
  "crossplay_partition_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...