Get locations

Get a list of locations.

/radar/entities/locations

get

Radar Entities

radar-get-entities-locations

Debug "planAvailability"

{
  "business": true,
  "enterprise": true,
  "free": true,
  "pro": true
}

Debug "tokenPermissions"

{
  "enum": [
    "com.cloudflare.api.user.read"
  ]
}

Debug "parameters"

[
  {
    "in": "query",
    "name": "limit",
    "schema": {
      "description": "Limit the number of objects in the response.",
      "example": 5,
      "type": "integer"
    }
  },
  {
    "in": "query",
    "name": "offset",
    "schema": {
      "description": "Number of objects to skip before grabbing results.",
      "type": "integer"
    }
  },
  {
    "in": "query",
    "name": "location",
    "schema": {
      "description": "Comma separated list of locations.",
      "example": "US,CA",
      "type": "string"
    }
  },
  {
    "in": "query",
    "name": "format",
    "schema": {
      "description": "Format results are returned in.",
      "enum": [
        "JSON",
        "CSV"
      ],
      "example": "json",
      "type": "string"
    }
  }
]

Debug "requestBody"

null

Debug "responses"

{
  "200": {
    "content": {
      "application/json": {
        "schema": {
          "properties": {
            "result": {
              "properties": {
                "locations": {
                  "items": {
                    "properties": {
                      "alpha2": {
                        "example": "AF",
                        "type": "string"
                      },
                      "latitude": {
                        "example": 33.939116,
                        "type": "string"
                      },
                      "longitude": {
                        "example": 67.709953,
                        "type": "string"
                      },
                      "name": {
                        "example": "Afghanistan",
                        "type": "string"
                      }
                    },
                    "required": [
                      "name",
                      "latitude",
                      "longitude",
                      "alpha2"
                    ],
                    "type": "object"
                  },
                  "type": "array"
                }
              },
              "required": [
                "locations"
              ],
              "type": "object"
            },
            "success": {
              "example": true,
              "type": "boolean"
            }
          },
          "required": [
            "result",
            "success"
          ],
          "type": "object"
        }
      }
    },
    "description": "Successful Response"
  },
  "400": {
    "content": {
      "application/json": {
        "schema": {
          "properties": {
            "errors": {
              "items": {
                "properties": {
                  "message": {
                    "type": "string"
                  }
                },
                "required": [
                  "message"
                ],
                "type": "object"
              },
              "type": "array"
            },
            "result": {
              "type": "object"
            },
            "success": {
              "example": false,
              "type": "boolean"
            }
          },
          "required": [
            "result",
            "success",
            "errors"
          ],
          "type": "object"
        }
      }
    },
    "description": "Bad Request"
  }
}

Debug "security"

[
  {
    "api_email": [],
    "api_key": []
  }
]