Search Maps

GET/api/v2/gaia/maps/search

Warning

This endpoint is in preview and may be modified or removed at any time. To use this endpoint, add preview=true to the request query parameters.

Retrieves all published maps containing the mapName (does not have to be exact).

Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:map-read.

Query parameters

mapName

string

The name of the map(s) to be queried.

pageSize

integer

optional

The maximum number of matching Gaia maps to return. Defaults to 50.

pageToken

string

optional

The page token indicates where to start paging. This should be omitted from the first page's request.

preview

boolean

optional

Enables the use of preview functionality.

Response body

SearchMapsResponse

object

The response body containing the queried Gaia maps

Hide child attributes

data

list<GaiaMapMetadata>

optional

Show child attributes

nextPageToken

string

optional

The page token indicates where to start paging. api-gateway's Core.PageToken is an immutable @Unsafe String, which is incompatible with Gaia's backend search. This is a custom PageToken that is an immutable @Safe String.

Examples

Request

Copied!

curl \
\t-H "Authorization: Bearer $TOKEN" \
	"https://$HOSTNAME/api/v2/gaia/maps/search?mapName=Example+map+name&preview=true"

Error responses

Error Name
`ErrorConvertingAppData`	Error Code	`INTERNAL`
	Status Code	500
	Description	Failed to convert MapAppData from artifact appData to gaia MapAppData
	Parameters	`mapId`
`SearchMapsPermissionDenied`	Error Code	`PERMISSION_DENIED`
	Status Code	403
	Description	Could not search the Map.
	Parameters

See Errors for a general overview of errors in the platform.