Skip to content

Map environments

GET
/api/v1/environments/map/{target}
curl --request GET \
--url https://osctrl.net/api/v1/environments/map/example \
--header 'Authorization: <Authorization>'

Returns an environment lookup map by target key.

target
required
string

Map target: id, name, or uuid

OK

Media typeapplication/json
object
key
additional properties
object
id
integer
name
string
uuid
string
Examplegenerated
{
"additionalProperty": {
"id": 1,
"name": "example",
"uuid": "example"
}
}

Bad request

Media typeapplication/json
object
code
string
error
string
Examplegenerated
{
"code": "example",
"error": "example"
}

Unauthorized

Media typeapplication/json
object
code
string
error
string
Examplegenerated
{
"code": "example",
"error": "example"
}

Forbidden

Media typeapplication/json
object
code
string
error
string
Examplegenerated
{
"code": "example",
"error": "example"
}

Not found

Media typeapplication/json
object
code
string
error
string
Examplegenerated
{
"code": "example",
"error": "example"
}

Conflict

Media typeapplication/json
object
code
string
error
string
Examplegenerated
{
"code": "example",
"error": "example"
}

Too many requests

Media typeapplication/json
object
code
string
error
string
Examplegenerated
{
"code": "example",
"error": "example"
}

Internal server error

Media typeapplication/json
object
code
string
error
string
Examplegenerated
{
"code": "example",
"error": "example"
}

Service unavailable

Media typeapplication/json
object
code
string
error
string
Examplegenerated
{
"code": "example",
"error": "example"
}