Skip to main content

Status Results (v3)

API Calls​

Note: These are v3 api calls implementations found under the path /api/v3

NameDescriptionShortcut
GET: List Status ResultsThis method retrieves the status results of all top level supergroups and their included endpointsDescription
GET: List Latest status result of endpoint by resource-idThis method retrieves the latest status result of a specific endpoint using as reference it's resource idDescription

[GET]: List Status results for top level groups and included endpoints​

The following methods can be used to obtain a tenant's Status timeline results for all top level groups and included endpoints. The api authenticates the tenant using the api-key within the x-api-key header. User can specify time granularity (monthly or daily) for retrieved results and also format using the Accept header.

Input​

/status/{report_name}?start_time={value}&end_time={value}&view={value}

Query Parameters​

TypeDescriptionRequiredDefault value
start_timeUTC time in W3C formatNObeginning of the current day (UTC, W3C format)
end_timeUTC time in W3C formatNOtime right now (UTC, W3C format)
viewview=details to display verbose details in results (such as threshold rules etc.) and view=latest to display only display the latest status value for each itemNO

Path Parameters​

NameDescriptionRequiredDefault value
{report_name}Name of the report that contains all the information about the profile, filter tags, group types etc.YES

Notes​

If user omits start_time and end_time parameters during the request the argo-web-api will respond with the latest status results of the current day

Example Request 1: Status results (for today or for a specific period)​

Request​

Method​

HTTP GET

Path​

For today's results just issue:

/api/v2/status/Report_A

For results in a specific period:

/api/v2/status/Report_A?start_time=2015-06-20T12:00:00Z&end_time=2015-06-26T23:00:00Z
Headers​
x-api-key: "tenant_key_value"
Accept: "application/json"

Response​

Code​
Status: 200 OK
Body​
{
  "groups": [
    {
      "name": "SITEA",
      "type": "SITES",
      "statuses": [
        {
          "timestamp": "2015-05-01T00:00:00Z",
          "value": "OK"
        },
        {
          "timestamp": "2015-05-01T01:00:00Z",
          "value": "CRITICAL"
        },
        {
          "timestamp": "2015-05-01T05:00:00Z",
          "value": "OK"
        },
        {
          "timestamp": "2015-05-01T23:59:59Z",
          "value": "OK"
        }
      ],
      "endpoints": [
        {
          "hostname": "cream01.example.foo",
          "service": "CREAM-CE",
          "info": {
            "Url": "http://example.foo/path/to/service"
          },
          "statuses": [
            {
              "timestamp": "2015-05-01T00:00:00Z",
              "value": "OK"
            },
            {
              "timestamp": "2015-05-01T01:00:00Z",
              "value": "CRITICAL"
            },
            {
              "timestamp": "2015-05-01T05:00:00Z",
              "value": "OK"
            },
            {
              "timestamp": "2015-05-01T23:59:59Z",
              "value": "OK"
            }
          ]
        },
        {
          "hostname": "cream02.example.foo",
          "service": "CREAM-CE",
          "statuses": [
            {
              "timestamp": "2015-05-01T00:00:00Z",
              "value": "OK"
            },
            {
              "timestamp": "2015-05-01T08:47:00Z",
              "value": "WARNING"
            },
            {
              "timestamp": "2015-05-01T12:00:00Z",
              "value": "OK"
            },
            {
              "timestamp": "2015-05-01T23:59:59Z",
              "value": "OK"
            }
          ]
        }
      ]
    },
    {
      "name": "SITEB",
      "type": "SITES",
      "statuses": [
        {
          "timestamp": "2015-05-01T00:00:00Z",
          "value": "OK"
        },
        {
          "timestamp": "2015-05-01T03:00:00Z",
          "value": "WARNING"
        },
        {
          "timestamp": "2015-05-01T17:53:00Z",
          "value": "CRITICAL"
        },
        {
          "timestamp": "2015-05-01T23:59:59Z",
          "value": "CRITICAL"
        }
      ],
      "endpoints": [
        {
          "hostname": "cream03.example.foo",
          "service": "CREAM-CE",
          "statuses": [
            {
              "timestamp": "2015-05-01T00:00:00Z",
              "value": "OK"
            },
            {
              "timestamp": "2015-05-01T03:00:00Z",
              "value": "WARNING"
            },
            {
              "timestamp": "2015-05-01T17:53:00Z",
              "value": "CRITICAL"
            },
            {
              "timestamp": "2015-05-01T23:59:59Z",
              "value": "CRITICAL"
            }
          ]
        }
      ]
    }
  ]
}

Example Request 2: Display only latest status results​

Request​

Method​

HTTP GET

Path​
/api/v2/status/Report_A?latest=true
Headers​
x-api-key: "tenant_key_value"
Accept: "application/json"

Response​

Code​
Status: 200 OK
Body​
{
  "groups": [
    {
      "name": "SITEA",
      "type": "SITES",
      "statuses": [
        {
          "timestamp": "2022-05-11T15:00:00Z",
          "value": "OK"
        }
      ],
      "endpoints": [
        {
          "hostname": "cream01.example.foo",
          "service": "CREAM-CE",
          "info": {
            "Url": "http://example.foo/path/to/service"
          },
          "statuses": [
            {
              "timestamp": "2022-05-11T15:00:00Z",
              "value": "OK"
            }
          ]
        },
        {
          "hostname": "cream02.example.foo",
          "service": "CREAM-CE",
          "statuses": [
            {
              "timestamp": "2022-05-11T15:00:00Z",
              "value": "OK"
            }
          ]
        }
      ]
    },
    {
      "name": "SITEB",
      "type": "SITES",
      "statuses": [
        {
          "timestamp": "2022-05-11T15:00:00Z",
          "value": "CRITICAL"
        }
      ],
      "endpoints": [
        {
          "hostname": "cream03.example.foo",
          "service": "CREAM-CE",
          "statuses": [
            {
              "timestamp": "2022-05-11T15:00:00Z",
              "value": "CRITICAL"
            }
          ]
        }
      ]
    }
  ]
}

[GET]: List latest status result for a specific endpoint using it's resource-id​

The following method can be used in it's simplest form to retrieve the latest status result of an endpoint, providing it's resource-id. User can specify with the parameter ?view=details to view the most recent timeline of results for this endpoint. Additionaly can use the start_time and end_time parameters to view the detailed timeline of results for this specific endpoint under a certain period of time

Input (simplest form)​

/status/{report_name}/id/{resource-id}

Input (advanced form)​

/status/{report_name}/id/{resource-id}?view=details&start_time={value}&end_time={value}

Query Parameters​

TypeDescriptionRequiredDefault value
start_timeUTC time in W3C formatNObeginning of the current day (UTC, W3C format)
end_timeUTC time in W3C formatNOtime right now (UTC, W3C format)
viewview=details to display the full timeline of resultsNO

Path Parameters​

NameDescriptionRequiredDefault value
{report_name}Name of the report that contains all the information about the profile, filter tags, group types etc.YES
{id}The resource-id corresponding to a specific endpointYES

Notes​

By default the request in it's simplest form will return the latest status result for the endpoint. With view=details the user can examine a detailed timeline for the current day, or specify a different period of time (using start_time and end_time)

Example Request 1: Latest status result for endpoint with id: simple-queue​

Request​

Method​

HTTP GET

Path​
/api/v2/status/Report_A/id/simple-queue
Headers​
x-api-key: "tenant_key_value"
Accept: "application/json"

Response​

Code​
Status: 200 OK
Body​
{
    "id": "simple-queue",
    "endpoints": [
        {
            "hostname": "queue01.example.com",
            "service": "compute.queue",
            "group": "Infra-01",
            "info": {
                "URL": "http://submit.queue01.example.com"
            },
            "statuses": [
                {
                    "timestamp": "2022-10-12T13:25:26Z",
                    "value": "OK"
                }
            ]
        }
    ]
}

Example Request 2: Todays timeline of status results for endpoint with id: simple-queue​

Request​

Method​

HTTP GET

Path​
/api/v2/status/Report_A/id/simple-queue?view=details
Headers​
x-api-key: "tenant_key_value"
Accept: "application/json"

Response​

Code​
Status: 200 OK
Body​
{
    "id": "simple-queue",
    "endpoints": [
        {
            "hostname": "queue01.example.com",
            "service": "compute.queue",
            "group": "Infra-01",
            "info": {
                "URL": "http://submit.queue01.example.com"
            },
            "statuses": [
                {
                    "timestamp": "2022-10-12T00:00:00Z",
                    "value": "OK"
                },
                {
                    "timestamp": "2022-10-12T09:53:00Z",
                    "value": "WARNING"
                },
                {
                    "timestamp": "2022-10-12T10:09:33Z",
                    "value": "WARNING"
                },
                {
                    "timestamp": "2022-10-12T13:25:26Z",
                    "value": "OK"
                }
            ]
        }
    ]
}

Example Request 3: Timeline of status results for endpoint with id: simple-queue between 1st and 3rd of September 2022​

Request​

Method​

HTTP GET

Path​
/api/v2/status/Report_A/id/simple-queue?view=details&start_date=2022-09-01T00:00:00Z&end_time=end_time=2022-09-03T23:59:59Z
Headers​
x-api-key: "tenant_key_value"
Accept: "application/json"

Response​

Code​
Status: 200 OK
Body​
{
    "id": "simple-queue",
    "endpoints": [
        {
            "hostname": "queue01.example.com",
            "service": "compute.queue",
            "group": "Infra-01",
            "info": {
                "URL": "http://submit.queue01.example.com"
            },
            "statuses": [
                {
                    "timestamp": "2022-09-01T00:00:00Z",
                    "value": "OK"
                },
                {
                    "timestamp": "2022-09-02T00:00:00Z",
                    "value": "OK"
                },
                {
                    "timestamp": "2022-09-02T12:04:55Z",
                    "value": "CRITICAL"
                },
                {
                    "timestamp": "2022-09-02T22:05:33Z",
                    "value": "OK"
                },
                {
                    "timestamp": "2022-10-03T00:00:00Z",
                    "value": "OK"
                },
                {
                    "timestamp": "2022-09-03T23:59:59Z",
                    "value": "OK"
                },
            ]
        }
    ]
}