Get Location

get https://app.mk.io/api/v1/locations/:location_name

Retrieves the specified Location.

Authentication

Authorization Bearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

location_name string Required

Response

200 Location
metadataobjectMetadataMinimalSchemaRequired
Metadata.
Show 3 propertiesHide 3 properties
displayNamestringOptional
The display name of the resource
idstringRequiredformat: uuid
The ID of the resource
namestringOptional
The name of the resource
specobjectLocationSpecSchema_v1Required
Specification.
Show 3 propertiesHide 3 properties
cloudobjectLocationCloudSchemaOptional
Cloud.
Show 3 propertiesHide 3 properties
displayNamestringRequired
The display name of the cloud.
namestringOptional
The unique name of the cloud.
regionobjectLocationRegionSchemaOptional
Cloud region.
Show 2 propertiesHide 2 properties
displayNamestringRequired
The display name of the cloud region.
namestringOptional
The name of the cloud region (unique within the cloud).
organizationobjectOrganizationSpecSchema_v1Optional
Organization information if applicable.
Show 2 propertiesHide 2 properties
idstring or nullOptionalformat: uuid
ID of the organization.
namestringRequired
Name of the organization.
typeenumRequired
Is the location one that is usable only by your your organization?
Allowed values:SaaSDedicated

Errors

400 Bad Request
errorobjectErrorDetailRequired
Pertinent information about the error
Show 3 propertiesHide 3 properties
codestringRequired
The error code.
detailstringRequired
The error message.
extraDetailmap from strings to anyOptional
Extra information regarding this error.
Show value schemaHide value schema
[any key]any
refstringRequired
A reference to the request that caused the error.
statusintegerRequired
The HTTP status code
401 Unauthorized
errorobjectErrorDetailRequired
Pertinent information about the error
Show 3 propertiesHide 3 properties
codestringRequired
The error code.
detailstringRequired
The error message.
extraDetailmap from strings to anyOptional
Extra information regarding this error.
Show value schemaHide value schema
[any key]any
refstringRequired
A reference to the request that caused the error.
statusintegerRequired
The HTTP status code
403 Forbidden
errorobjectErrorDetailRequired
Pertinent information about the error
Show 3 propertiesHide 3 properties
codestringRequired
The error code.
detailstringRequired
The error message.
extraDetailmap from strings to anyOptional
Extra information regarding this error.
Show value schemaHide value schema
[any key]any
refstringRequired
A reference to the request that caused the error.
statusintegerRequired
The HTTP status code
404 Not Found
errorobjectErrorDetailRequired
Pertinent information about the error
Show 3 propertiesHide 3 properties
codestringRequired
The error code.
detailstringRequired
The error message.
extraDetailmap from strings to anyOptional
Extra information regarding this error.
Show value schemaHide value schema
[any key]any
refstringRequired
A reference to the request that caused the error.
statusintegerRequired
The HTTP status code
429 Too Many Requests
errorobjectErrorDetailRequired
Pertinent information about the error
Show 3 propertiesHide 3 properties
codestringRequired
The error code.
detailstringRequired
The error message.
extraDetailmap from strings to anyOptional
Extra information regarding this error.
Show value schemaHide value schema
[any key]any
refstringRequired
A reference to the request that caused the error.
statusintegerRequired
The HTTP status code
500 Internal Server Error
errorobjectErrorDetailRequired
Pertinent information about the error
Show 3 propertiesHide 3 properties
codestringRequired
The error code.
detailstringRequired
The error message.
extraDetailmap from strings to anyOptional
Extra information regarding this error.
Show value schemaHide value schema
[any key]any
refstringRequired
A reference to the request that caused the error.
statusintegerRequired
The HTTP status code