Skip to main content

Regions

The regions a workspace's data can live in, with the addresses its data is sent to and queried at.

Contains: Credential

Region object​

A region is a place a workspace's data can live, with the addresses its data is sent to and queried at.

idstring

The region's id.

namestring

The region's name.

sort_orderinteger

Where the region sorts in a list of regions.

ingest_uristring

The address agents send this region's log data to.

query_uristring

The address this region's data is queried at.

bigquery_locationstring or null

The BigQuery location this region's workspace datasets are created in, such as US. list-regions returns it only when named in fields; a workspace's region always carries it.

List regions​

GET/regions
Preview

Returns every region a workspace's data can live in, in sort order, with the addresses its data is sent to and queried at.

curl -X GET \  "https://engine.sparklogs.app/app-api/regions" \  -H "Authorization: Bearer $SPARKLOGS_TOKEN"

Access

Works with
Signed-in person, Personal token, OAuth token, Workspace token

Needs no privilege: every caller gets the same list of regions.

Behavior

Retry
Safe to send again

Query parameters

fieldsarray of string

Comma-separated top-level fields of each object to return instead of the default set.

Sent by default: idnamesort_orderingest_uriquery_uri

Sent only when named in fields: bigquery_location

Response 200

regionsarray of Regionrequired

Every one of the regions you can see.

messagestringrequired

What the call did, as a short phrase for a person to read. Its wording may change: act on the HTTP status.

Errors

StatusCodeWhenSend again?
400APP_API_ERR_BAD_PARAMETERSA query parameter it does not take, one given twice, or fields naming a field it does not have.No

Plus the errors every call can return.