Instance Actions

https://api.losant.com/instances/INSTANCE_ID

Below are the various requests that can be performed against the Instance resource, as well as the expected parameters and the potential responses.

Generate Report

Generates a CSV report on instance stats

Method And Url

POST https://api.losant.com/instances/INSTANCE_ID/generateReport

Authentication

A valid api access token is required to access this endpoint. The token must include at least one of the following scopes: all.Instance, all.Instance.read, all.User, all.User.read, instance.*, or instance.generateReport.

Request Path Components

Request Headers

Request Body

The body of the request should be serialized JSON that validates against the Instance Report Options Post schema. For example, the following would be a valid body for this request:

{
  "email": "email@example.com",
  "callbackUrl": "https://example.com/callback",
  "resourceGroupBy": "organization",
  "dateGroupBy": "month",
  "includeSandbox": false,
  "start": "2020-01-01T00:00:00.000Z",
  "end": "2020-01-31T11:59:59.999Z"
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X POST \
    https://api.losant.com/instances/INSTANCE_ID/generateReport

Successful Responses

Error Responses

Get

Returns an instance

Method And Url

GET https://api.losant.com/instances/INSTANCE_ID

Authentication

A valid api access token is required to access this endpoint. The token must include at least one of the following scopes: all.Instance, all.Instance.read, all.User, all.User.read, instance.*, or instance.get.

Request Path Components

Request Headers

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X GET \
    https://api.losant.com/instances/INSTANCE_ID

Successful Responses

Error Responses

Historical Summaries

Return historical summary entries for an instance

Method And Url

GET https://api.losant.com/instances/INSTANCE_ID/historicalSummaries

Authentication

A valid api access token is required to access this endpoint. The token must include at least one of the following scopes: all.Instance, all.Instance.read, all.User, all.User.read, instance.*, or instance.historicalSummaries.

Request Path Components

Request Query Parameters

Request Headers

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X GET \
    https://api.losant.com/instances/INSTANCE_ID/historicalSummaries

Successful Responses

Error Responses

Patch

Updates information about an instance

Method And Url

PATCH https://api.losant.com/instances/INSTANCE_ID

Authentication

A valid api access token is required to access this endpoint. The token must include at least one of the following scopes: all.Instance, all.User, instance.*, or instance.patch.

Request Path Components

Request Headers

Request Body

The body of the request should be serialized JSON that validates against the Instance Patch schema. For example, the following would be a valid body for this request:

{
  "reportConfigs": [
    {
      "emails": [
        "email@example.com"
      ],
      "callbackUrl": "https://example.com/callback",
      "resourceGroupBy": "organization",
      "dateGroupBy": "month",
      "includeSandbox": false,
      "periods": 3,
      "cron": "0 4 1 * *"
    },
    {
      "emails": [
        "email@example.com",
        "anotheremail@example.com"
      ],
      "resourceGroupBy": "application",
      "dateGroupBy": "month",
      "includeSandbox": true,
      "cron": "0 4 1 * *"
    }
  ]
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X PATCH \
    -d '{"reportConfigs":[{"emails":["email@example.com"],"callbackUrl":"https://example.com/callback","resourceGroupBy":"organization","dateGroupBy":"month","includeSandbox":false,"periods":3,"cron":"0 4 1 * *"},{"emails":["email@example.com","anotheremail@example.com"],"resourceGroupBy":"application","dateGroupBy":"month","includeSandbox":true,"cron":"0 4 1 * *"}]}' \
    https://api.losant.com/instances/INSTANCE_ID

Successful Responses

Error Responses