> This page is for mk.io. > For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://mediakind.ferndocs.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://mediakind.ferndocs.com/_mcp/server. # List available Locations GET https://app.mk.io/api/v1/locations ## Listing, Sorting and Filtering Locations This endpoint returns the list of locations. ### Sorting The results from this endpoint can be ordered using the `$orderby` query parameter. Specify a list of field names, separated by commas where each one can optionally specify `asc` or `desc`. Sorting is valid on the following fields: `displayName`, `id`, `name` ### Filtering The `$filter` query parameter allows for locations to be filtered on the basis of fields in the schema using OData query syntax. See [this document](https://learn.microsoft.com/en-us/odata/concepts/queryoptions-overview#filter) for more details on the syntax used. Filters are valid on the following fields: `cloud/name`, `cloud/region/name`, `displayName`, `id`, `name` ### Examples: `?$top=10` - Returns only the first 10 locations from the list. `?$orderby=name desc` - Sorts locations by name in descending order. `?$filter=name eq 'descriptive name'` - Returns locations that match the provided name. RBAC Capability Required: `core.location.get` Reference: https://mediakind.ferndocs.com/mkio/api/management/locations/list-available-locations ## Authentication - `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer `, where token is your auth token. ## Request ### Query parameters - `$orderby` (string, optional) — Specifies the key by which the result collection should be ordered. - `$filter` (string, optional) — Restricts the set of items returned. - `$top` (string, optional) — Specifies a non-negative integer `n` that limits the number of items returned from a collection. The service returns the number of available items up to but not greater than the specified value `n`. - `$skiptoken` (string, optional) — Specifies a start offset to support paginated results. Use `@odata.nextLink` in the result object to enumerate the collection - it will be present only if there's more than one page of entities. ## Response ### 200 A list of locations - `value` (list of LocationSchema_v1, required) — A list of Locations - `kind` (string, optional) — The type of the resource. ## Errors ### 400 Bad Request Error Bad Request - `error` (ErrorDetail, required) — Pertinent information about the error - `ref` (string, required) — A reference to the request that caused the error. - `status` (integer, required) — The HTTP status code ### 401 Unauthorized Error Unauthorized - `error` (ErrorDetail, required) — Pertinent information about the error - `ref` (string, required) — A reference to the request that caused the error. - `status` (integer, required) — The HTTP status code ### 403 Forbidden Error Forbidden - `error` (ErrorDetail, required) — Pertinent information about the error - `ref` (string, required) — A reference to the request that caused the error. - `status` (integer, required) — The HTTP status code ### 404 Not Found Error Not Found - `error` (ErrorDetail, required) — Pertinent information about the error - `ref` (string, required) — A reference to the request that caused the error. - `status` (integer, required) — The HTTP status code ### 429 Too Many Requests Error Too Many Requests - `error` (ErrorDetail, required) — Pertinent information about the error - `ref` (string, required) — A reference to the request that caused the error. - `status` (integer, required) — The HTTP status code ### 500 Internal Server Error Internal Server Error - `error` (ErrorDetail, required) — Pertinent information about the error - `ref` (string, required) — A reference to the request that caused the error. - `status` (integer, required) — The HTTP status code ## Types ### LocationSchema_v1 - `metadata` (MetadataMinimalSchema, required) — Metadata. - `spec` (LocationSpecSchema_v1, required) — Specification. ### ErrorDetail - `code` (string, required) — The error code. - `detail` (string, required) — The error message. - `extraDetail` (map from string to any, optional) — Extra information regarding this error. ### MetadataMinimalSchema - `id` (string, required) — The ID of the resource - `displayName` (string, optional) — The display name of the resource - `name` (string, optional) — The name of the resource ### LocationSpecSchema_v1 - `type` (enum, required) — Is the location one that is usable only by your your organization? - Allowed values: `SaaS`, `Dedicated` - `cloud` (LocationCloudSchema, optional) — Cloud. - `organization` (OrganizationSpecSchema_v1, optional) — Organization information if applicable. ### LocationCloudSchema - `displayName` (string, required) — The display name of the cloud. - `name` (string, optional) — The unique name of the cloud. - `region` (LocationRegionSchema, optional) — Cloud region. ### OrganizationSpecSchema_v1 - `name` (string, required) — Name of the organization. - `id` (string, optional, nullable) — ID of the organization. ### LocationRegionSchema - `displayName` (string, required) — The display name of the cloud region. - `name` (string, optional) — The name of the cloud region (unique within the cloud). ## Examples **Response** ```json { "value": [ { "metadata": { "id": "string", "displayName": "string", "name": "string" }, "spec": { "type": "SaaS", "cloud": { "displayName": "Azure", "name": "azure", "region": { "displayName": "UK South", "name": "uksouth" } }, "organization": { "name": "MediaKind", "id": "string" } } } ], "kind": "string" } ``` **SDK Code** ```python import requests url = "https://app.mk.io/api/v1/locations" headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript const url = 'https://app.mk.io/api/v1/locations'; const options = {method: 'GET', headers: {Authorization: 'Bearer '}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://app.mk.io/api/v1/locations" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Authorization", "Bearer ") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://app.mk.io/api/v1/locations") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer ' response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://app.mk.io/api/v1/locations") .header("Authorization", "Bearer ") .asString(); ``` ```php request('GET', 'https://app.mk.io/api/v1/locations', [ 'headers' => [ 'Authorization' => 'Bearer ', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://app.mk.io/api/v1/locations"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = ["Authorization": "Bearer "] let request = NSMutableURLRequest(url: NSURL(string: "https://app.mk.io/api/v1/locations")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```