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).
booleanRepresents a boolean value that restricts an endpoint to preview mode when set to true.
stringThe name of the map(s) to be queried.
integerThe maximum number of matching Gaia maps to return. Defaults to 50.
stringThe page token indicates where to start paging. This should be omitted from the first page's request.
objectSuccess response.
list<GaiaMapMetadata>objectstringThe RID of a Gaia Map.
stringThe GID of a Gaia map
stringstringThe time when the map was first created, based on UTC timezone.
stringThe last time the map was modified, based on UTC timezone.
integerThe number of layers on the map.
integerThe number of elements on the map.
stringThe page token indicates where to start paging. This should be omitted from the first page's request.
To fetch the next page, clients should take the value from the nextPageToken field of the previous response
and populate the next request's pageToken field with it.
1
2
3
curl \
-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/gotham/v1/maps?preview=true&mapName=Example+Map+Name&pageSize=10&pageToken="1
2
3
4
5
6
7
8
9
10
11
12
{
"results": [
{
"mapRid": "ri..map.a1A2bcD3e45fg6h7ij",
"name": "Example Map Name",
"createAt": "2023-03-21T01:14:20.326Z",
"lastModified": "2023-03-23T17:38:29.323Z",
"numLayers": 1,
"numElements": 5
}
]
}