Get a list of available locations

GET https://api.sandbox-gameye.gameye.net/available-location/{image}

Retrieve all locations that are currently able to host your image. This includes an IPV4 address that you may send ICMP ping messages to, to figure out the latency to this location. Please do not cache this list anywhere as it may change.

Code Examples

cURL

curl --location --globoff 'https://api.sandbox-gameye.gameye.net/available-location/{image}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("Accept", "application/json");
myHeaders.append("Content-Type", "application/json");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://api.sandbox-gameye.gameye.net/available-location/{image}", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

Ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.sandbox-gameye.gameye.net/available-location/{image}")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Accept"] = "application/json"
request["Content-Type"] = "application/json"

response = https.request(request)
puts response.read_body

Python

import requests
import json

url = "https://api.sandbox-gameye.gameye.net/available-location/{image}"

payload = {}
headers = {
   'Accept': 'application/json',
   'Content-Type': 'application/json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

Responses

200

Ok

Field	Type	Required
locations	array	Yes

// Ok
{
  "locations": [
    {
      "id": "",
      "ips": [
        ""
      ]
    }
  ]
}

401

You are not authorized to list available locations. Please make sure that the included bearer token is correct.

Field	Type	Required
statusCode	integer	Yes
code	string	Yes
message	string	Yes
details	string	Yes
path	string	Yes
timestamp	string	Yes
identifier	string	Yes
violations	array	No

// You are not authorized to list available locations. Please make sure that
the included bearer token is correct.

{
  "statusCode": 0,
  "code": "",
  "message": "",
  "details": "",
  "path": "",
  "timestamp": "",
  "identifier": "",
  "violations": [
    {
      "field": "",
      "description": ""
    }
  ]
}

404

Image not found or you are not authorized to use this image.

Field	Type	Required
statusCode	integer	Yes
code	string	Yes
message	string	Yes
details	string	Yes
path	string	Yes
timestamp	string	Yes
identifier	string	Yes
violations	array	No

// Image not found or you are not authorized to use this image.

{
  "statusCode": 0,
  "code": "",
  "message": "",
  "details": "",
  "path": "",
  "timestamp": "",
  "identifier": "",
  "violations": [
    {
      "field": "",
      "description": ""
    }
  ]
}