Overview of Async GET Requests

An asynchronous job collects and downloads all matching records as a single job. You can configure a script to poll the job until it finishes, then download the results using the job location HREF listed in the response.

Collection vs. Instance

GET collection methods return HREF path properties for each resource. Perform other REST operations on individual instances of these resources (such as POST, PUT, and DELETE) using the HREF to identify the resources to operate.

For example, the API response body for getting a collection of labels returns a list of labels, each identified by an HREF path. In this instance, the general syntax for the API call looks like this:

GET https://scp.illum.io:8443[api_version][org_href]labels

[org_href] identifies the organization from which you want to get a collection of labels.

A single label instance in the response is identified by its HREF path:

{
    href: "/orgs/2/labels/8"
    key: "env"
    value: "Prod"
    created_at: "2020-01-22T18:24:33Z"
    updated_at: "2020-01-22T18:24:40Z"
    created_by: {
	href: "/users/9"
    }
    updated_by: {
	href: "/users/9"
    }
}

To perform other operations on this label (href: "/orgs/2/labels/8"), you can provide this HREF in the API call to operate on this label instance.

For example:

PUT https://scp.illum.io:8443/api/v2/orgs/2/labels/8

Async GET Supported APIs

These APIs support async GET collections:

Description	Resource Type	Exposure
agents/update	`GET [api_version][org_href]/agents` `GET [api_version][org_href]/agents/update`	Experimental Experimental
audit_log_events	`GET [api_version][org_href]/audit_log_events`	Experimental
auth_security_principals	`GET [api_version][org_href]/auth_securiuty_principals`	Experimental
authentication_settings/ password_policy	`GET [api_version][org_href]/authentication_settings/ password_policy`	Experimental
datafiles	`GET [api_version][org_href]/datafiles`	Experimental
events	`GET [api_version][org_href]/events`	Experimental
jobs	`GET [api_version][org_href]/jobs`	Experimental
labels	`GET [api_version][org_href]/labels`	Both
network_devices/ network_endpoints	`GET [api_version][org_href]/network_devices/network_endpoints`	Experimental
network_enforcement_nodes	`GET [api_version][org_href]/network_enforcement_nodes`	Experimental
node_available	`GET [api_version][org_href]/node_available`	Both
Pairing Profiles	`GET [api_version][org_href]/pairing_profiles`	Experimental
permissions	`GET [api_version][org_href]/permissions`	Experimental
security_principals	`GET [api_version][org_href]/sec_policy/draft/security_principals`	Experimental
system_events	`GET [api_version][org_href]/system_events`
vulnerability_reports	`GET [api_version][org_href]/vulnerability_reports`	Experimental
sec_policy/draft/
allow	`GET [api_version][org_href]/sec_policy/draft/allow`	Experimental
dependencies	`GET [api_version][org_href]/sec_policy/draft/dependencies`	Experimental
ip_lists	`GET [api_version][org_href]/sec_policy/draft/ip_lists`	Both
label_groups	`GET [api_version][org_href]/sec_policy/draft/label_groups`	Experimental
label_groups/member-of	`GET [api_version][org_href]/sec_policy/draft/label_groups/member-of`	Experimental
modified_objects	`GET [api_version][org_href]/sec_policy/draft/modified_objects`	Experimental
pending	`GET [api_version][org_href]/sec_policy/draft/pending`	Experimental
rule_sets	`GET [api_version][org_href]/sec_policy/draft/rule_sets`	Both
rule_sets/sec_rule	`GET [api_version][org_href]/sec_policy/draft/rule_sets/<rule_set_id>/sec_rules`	Both
services	`GET [api_version][org_href]/sec_policy/draft/services`	Both
virtual_service	`GET [api_version][org_href]/sec_policy/draft/virtaual_services`	Both
settings/
settings	`GET [api_version][org_href]/settings`
syslog/destinations	`GET [api_version][org_href]/settings/syslog/destinations`	Experimental
workloads	`GET [api_version][org_href]/settings/workloads`	Experimental
users/
users	`GET [api_version][org_href]/users`	Stable
api_keys	`GET [api_version][org_href]/users/api_keys`	Both
orgs	`GET [api_version][org_href]/users/orgs`	Experimental
login	`GET [api_version][org_href]/users/login`	Stable
workloads/
workloads/	`GET [api_version][org_href]/workloads`	Both
interfaces	`GET [api_version][org_href]/workloads/<workload_id>interfaces`	Both

REST APIs for 24.5