Ping

GET /v1/ping

Pings the Amper platform.

Request Parameters

(none)

Example Request

Note: The authorization header may be included in the request, but it is not required.

GET /v1/ping HTTP/1.1
Host: api.ampermusic.com
Authorization: Basic abcxyz

Response Data

Data Item Type Description
data object
data.type string The type of data (ping in this case)
data.id string 0
data.attributes object
data.attributes.ping string Always pong
data.attributes.user_id string The user ID of the currently-authenticated user. If the user is anonymous or has a bad token, the value is null
data.links object
data.links.self string The account URL
data.links.user string The alphanumeric ID of the user, or null if no Authorization header.
links object
links.self string This account URL

Example Response

Header

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

Body

{
    "data": {
        "type": "ping",
        "id": "0",
        "attributes": {
            "ping": "pong",
            "user_id": "abcd1234efgh5678ijkl9012mnop"
        },
        "links": {
            "self": "https://api.ampermusic.com/v1/ping",
            "user": "https://api.ampermusic.com/v1/users/abcd1234efgh5678ijkl9012mnop"
        }
    },
    "links": {
        "self": "https://api.ampermusic.com/v1/ping"
    }
}