openapi: 3.2.0
info:
title: Checkly Public Location API
version: v1
description: These are the docs for the newly released Checkly Public API.<br />If you have any questions, please do not hesitate to get in touch with us.
servers:
- url: https://api.checklyhq.com
security:
- Bearer: []
tags:
- name: Location
paths:
/v1/locations:
get:
summary: Lists all supported locations
operationId: getV1Locations
description: Lists all supported locationss.
tags:
- Location
responses:
'200':
description: Successful
content:
application/json:
schema:
$ref: '#/components/schemas/LocationList'
'429':
description: Too Many Requests
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsError'
parameters:
- schema:
type: string
x-format:
guid: true
description: Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general
required: false
description: Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general
name: x-checkly-account
in: header
components:
schemas:
attributes:
type: object
Model2:
type: string
enum:
- Too Many Requests
LocationList:
type: array
items:
$ref: '#/components/schemas/PublicLocation'
TooManyRequestsError:
type: object
properties:
statusCode:
type: number
enum:
- 429
error:
$ref: '#/components/schemas/Model2'
message:
type: string
example: Too Many Requests
attributes:
$ref: '#/components/schemas/attributes'
required:
- statusCode
- error
PublicLocation:
type: object
properties:
region:
type: string
example: us-east-1
description: The unique identifier of this location.
name:
type: string
example: N. Virginia
description: Friendly name of this location.
required:
- region
- name
securitySchemes:
Bearer:
type: http
scheme: bearer
bearerFormat: Bearer
description: 'The Checkly Public API uses API keys to authenticate requests. You can get the API Key <a href="https://app.checklyhq.com/settings/user/api-keys" target="_blank">here</a>.</br>Your API key is like a password: <br>keep it secure!</br></br>Authentication to the API is performed using the Bearer auth method in the Authorization header and using the account ID.</br></br>For example, set <b>Authorization</b> header while using cURL: <code>curl -H "Authorization: Bearer [apiKey]" "X-Checkly-Account: [accountId]"</code></br>'