Skip to main content

Ingest keys

An ingest key lets a sender other than a SparkLogs Agent send log data for an organization; list and read them, create one, read or replace its secret, and rename, move, delete or restore one.

A SparkLogs Agent's id names no ingest key here, and returns 404 to a read and 403 to a change, as an id that does not exist does.

IngestKey object​

An ingest key is a secret a sender other than a SparkLogs Agent presents to send log data for one organization.

iduuid

The ingest key's id.

workspace_iduuid

The workspace the ingest key belongs to.

namestring or null

The ingest key's name, a label that changes only when you change it.

descriptionstring or null

The ingest key's description.

organization_iduuid

The organization the ingest key sends data for.

patharray of uuid or null

The organization ids from the top-level organization down to the key's own, then the key's id.

data_statusone of the values below

Whether data is arriving with the key, worked out from when its data last arrived: on a list at the page's as_of, the same instant for every page of one walk, and on a read of one key when the response is written. A key has no heartbeat, so a sender that sends nothing for hours reads offline. The SparkLogs MCP server shows the same value as agent_status on an ingest key's row.

  • online Data arrived with the key in the last 3 hours.
  • offline No data has arrived with it for longer than that.
  • never_seen No data has arrived with it yet.
  • deleted The ingest key is deleted.
last_data_atdate-time or null

When log data sent with the key last arrived, recorded at most once every five minutes. Null until data first arrives.

created_atdate-time

When the ingest key was created.

updated_atdate-time

When the ingest key's record last changed. Arriving data changes it, so it says little about when anything else about the key changed.

deleted_atdate-time or null

When the ingest key was deleted; null while it is live.

organization_deleted_atdate-time or null

When the key's organization was deleted; null while the organization is live.

custom_fieldsmap of any or null

Custom fields recorded on the ingest key, as an object of string, number and boolean values. Not for secrets: anyone who may read the ingest key may read them.

List ingest keys​

GET/workspaces/{workspace_id}/ingest-keys
Preview

Returns the ingest keys you can see, a page at a time, in id order, never with their secrets. Seeing a key takes organization.read and agent.read at its organization. Filter by organization, with or without the organizations below it, by name, or by inactivity; filters combine, a row passing every one given. A moving inactive_before cutoff, such as 14 days before now, and data_status are worked out at the walk's as_of, the same instant for every page.

curl -X GET \  "https://engine.sparklogs.app/app-api/workspaces/5e1f0a00-0000-4000-8000-000000000001/ingest-keys" \  -H "Authorization: Bearer $SPARKLOGS_TOKEN"

Access

Works with
Signed-in person, Personal token, OAuth token, Workspace token
Scope
workspace:read
Privilege
agent.read

Needs agent.read. agent.read applies at each organization a grant covers and every organization below it. agent.read also admits reading ingest keys, but never their secrets. A caller who reaches no organization gets an empty list.

Behavior

Retry
Safe to send again
Paging
Cursor · 1000 a page by default, up to 5000

Path parameters

workspace_iduuidrequired

The workspace's id.

Query parameters

organization_iduuid

Only ingest keys of this organization.

subtreeboolean

true adds the ingest keys of every organization below organization_id. true and false are the only values it takes.

Default: false

idarray of string

Only the ingest keys with these ids. A comma-separated list of at most 100 ids matches any of them.

namestring

Only ingest keys of this name: the way to find a key created by a call whose answer was lost. Matched exactly, ignoring case; every match you can see is returned. Spaces around the value are ignored.

inactive_beforedate-time

Only ingest keys created, and last sending data, before this time: keys gone quiet, at a cutoff you choose. An RFC 3339 time.

deletedone of the values below

Which ingest keys to list, by whether they or their organization are deleted.

  • exclude Ingest keys that are live in a live organization. The default.
  • include Every ingest key, deleted ones and those of deleted organizations included.
  • only Ingest keys that are deleted or whose organization is.

Default: exclude

limitinteger

How many ingest keys a page holds: 1 to 5000, 1000 by default.

Default: 10001 to 5000

cursorstring

The next_cursor of the previous page, with the same filters.

fieldsarray of string

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

Sent by default: idworkspace_idnamedescriptionorganization_idpathdata_statuslast_data_atcreated_atupdated_atdeleted_atorganization_deleted_at

Sent only when named in fields: custom_fields

Response 200

ingest_keysarray of IngestKeyrequired

The ingest keys on this page.

next_cursorstring or nullrequired

Null on the last page. Otherwise pass it as cursor for the next page.

as_ofdate-timerequired

The instant this walk's values worked out from the clock, and its filters on them, are worked out at: fixed on the first page and the same on every page after it.

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
400APP_API_ERR_BAD_PARAMETERSA filter's value is empty, names an empty item, is not one of the values the filter takes, or is not an id or a time where the filter asks for one; parameter names the filter.No
400APP_API_ERR_BAD_PARAMETERSorganization_id is not a UUID, subtree is neither true nor false or comes without organization_id, deleted is not a value it takes, or limit is out of range, or cursor cannot be read or was sent with other filters.No
403APP_API_ERR_NO_PRIVILEGEtoken_scopeno_privilegeYou do not hold organization.read and agent.read. The same refusal comes when the path names a workspace other than the token's own.No

Plus the errors every call can return.

Related

Read an ingest key​

GET/workspaces/{workspace_id}/ingest-keys/{id}
Preview

Returns one ingest key you can see, deleted or not, without its secret. One you cannot see returns 404, as one that does not exist does, and so does the id of a SparkLogs Agent.

curl -X GET \  "https://engine.sparklogs.app/app-api/workspaces/5e1f0a00-0000-4000-8000-000000000001/ingest-keys/a9e70000-0000-4000-8000-000000000204" \  -H "Authorization: Bearer $SPARKLOGS_TOKEN"

Access

Works with
Signed-in person, Personal token, OAuth token, Workspace token
Scope
workspace:read
Privilege
agent.read

Needs agent.read. agent.read applies at each organization a grant covers and every organization below it. agent.read also admits reading ingest keys, but never their secrets.

Behavior

Retry
Safe to send again

Path parameters

workspace_iduuidrequired

The workspace's id.

iduuidrequired

The ingest key's id.

Query parameters

fieldsarray of string

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

Sent by default: idworkspace_idnamedescriptionorganization_idpathdata_statuslast_data_atcreated_atupdated_atdeleted_atorganization_deleted_at

Sent only when named in fields: custom_fields

Response 200

ingest_keyIngestKeyrequired

The ingest key.

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
400APP_API_ERR_BAD_PARAMETERSid is not a UUID.No
403APP_API_ERR_NO_PRIVILEGEtoken_scopeno_privilegeYou do not hold organization.read and agent.read. The same refusal comes when the path names a workspace other than the token's own.No
404APP_API_ERR_RECORD_NOT_FOUNDNo such ingest key, or one you cannot see; a SparkLogs Agent's id answers this too.No

Plus the errors every call can return.

Related

Create an ingest key​

POST/workspaces/{workspace_id}/ingest-keys
PreviewReturns a secret

Creates an ingest key for organization_id and returns the key senders present. Needs ingest_key.create at that organization.

curl -X POST \  "https://engine.sparklogs.app/app-api/workspaces/5e1f0a00-0000-4000-8000-000000000001/ingest-keys" \  -H "Authorization: Bearer $SPARKLOGS_TOKEN" \  -H "Content-Type: application/json" \  -d '{    "name": "Harbor Dental servers",    "organization_id": "0a9e0000-0000-4000-8000-000000000105"  }'

Access

Works with
Signed-in person, Personal token, OAuth token, Workspace token
Scope
any of fleet:deployfleet:write
Privilege
ingest_key.create

Needs ingest_key.create. ingest_key.create applies at each organization a grant covers and every organization below it. ingest_key.create also admits moving a SparkLogs Agent or an ingest key into an organization, with agent.write at the one it leaves.

Behavior

Retry
Read before sending again
Audit log
Recorded

Path parameters

workspace_iduuidrequired

The workspace's id.

Request body

organization_iduuidrequired

The organization the ingest key sends data for. Required.

namestringrequired

The ingest key's name. Cleaned, as every name is. Required.

at most 128 characters

descriptionstring or null

The ingest key's description.

at most 2048 characters

Response 200

iduuidrequired

The new ingest key's id.

keystringrequired

The key a sender presents to send log data. Keep it secret; it can be read again later by anyone holding ingest_key.reveal.

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_PARAMETERSThe URL carries a query parameter, which a write does not take: its fields come from its body.No
400APP_API_ERR_BAD_PARAMETERSThe body is not a JSON object, is not sent as application/json, names a field the call does not take, or a field has the wrong type; parameter names the field, or Content-Type.No
400APP_API_ERR_MISSING_PARAMETERorganization_id or name is left out or empty.No
400APP_API_ERR_BAD_PARAMETERSorganization_id is not a UUID or names a deleted organization.No
400APP_API_ERR_PARAMETER_TOO_LONGname is longer than 128 characters, or description longer than 2048.No
403APP_API_ERR_NO_PRIVILEGE_ON_THIS_ORGANIZATIONtoken_scopeno_privilegeYou do not hold ingest_key.create at organization_id, or it names no organization you can see. The same refusal comes when the path names a workspace other than the token's own.No
413APP_API_ERR_BODY_TOO_LARGEThe body is larger than 1 MiB.No

Plus the errors every call can return.

Related

Update an ingest key​

PATCH/workspaces/{workspace_id}/ingest-keys/{id}
Preview

Changes an ingest key's name, description or custom fields; a field left out keeps its value. Needs agent.write at its organization.

curl -X PATCH \  "https://engine.sparklogs.app/app-api/workspaces/5e1f0a00-0000-4000-8000-000000000001/ingest-keys/a9e70000-0000-4000-8000-000000000204" \  -H "Authorization: Bearer $SPARKLOGS_TOKEN" \  -H "Content-Type: application/json" \  -d '{    "name": "Harbor Dental server room"  }'

Access

Works with
Signed-in person, Personal token, OAuth token, Workspace token
Scope
fleet:write
Privilege
agent.write

Needs agent.write. agent.write applies at each organization a grant covers and every organization below it. agent.write also admits changing and moving ingest keys.

Behavior

Retry
Safe to repeat: ends in the same state
Audit log
Recorded

Path parameters

workspace_iduuidrequired

The workspace's id.

iduuidrequired

The ingest key's id.

Request body

No field is required. Send no body to accept the defaults.

namestring

The new name, a label only. Cleaned, as every name is. null or an empty string returns 400.

left out keeps · null is refused · empty string is refused

at most 128 characters

descriptionstring or null

The new description. null or an empty string clears it.

left out keeps · null clears · empty string clears

at most 2048 characters

custom_fieldsmap of any or null

Changes to the custom fields, merged into the stored ones: a key left out keeps its value, null removes it, and a string, a boolean, or a number of at most 32 characters in plain decimal digits with no exponent sets it. A number is kept by its value, so 1.50 reads back as 1.5. At most 50 keys, each 1 to 64 letters, digits, _, - and ., and 8 KiB as JSON. Write a time as RFC 3339 in UTC. Not for secrets.

Response 200

iduuidrequired

The id of the row the call created or changed.

cache_clear_statusone of the values below, or null

Sent when the change has to reach every region's cache: how far it got.

  • ok Every region's cache has the change.
  • failed A region could not be reached. The change is saved, and that region can act on the earlier state until its cache expires.
  • disabled This environment does not clear regional caches. The change is saved, and each region can act on the earlier state until its cache expires.
cache_clear_messagestring or null

Sent with a cache_clear_status other than ok: what it means, for a person to read.

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_PARAMETERSThe URL carries a query parameter, which a write does not take: its fields come from its body.No
400APP_API_ERR_BAD_PARAMETERSid is not a UUID.No
400APP_API_ERR_BAD_PARAMETERSThe body is not a JSON object, is not sent as application/json, names a field the call does not take, or a field has the wrong type; parameter names the field, or Content-Type.No
400APP_API_ERR_BAD_PARAMETERSname is empty.No
400APP_API_ERR_PARAMETER_TOO_LONGname is longer than 128 characters, or description longer than 2048.No
403APP_API_ERR_NO_PRIVILEGE_ON_THIS_ORGANIZATIONtoken_scopeno_privilegeThe ingest key does not exist, is in another workspace or is outside your reach, id names a SparkLogs Agent, or you do not hold the privilege at its organization. The same refusal comes when the path names a workspace other than the token's own.No
413APP_API_ERR_BODY_TOO_LARGEThe body is larger than 1 MiB.No

Plus the errors every call can return.

Related

Delete an ingest key​

DELETE/workspaces/{workspace_id}/ingest-keys/{id}
PreviewDestructive

Marks an ingest key deleted; senders using it are refused from then on, and cache_clear_status says whether every region refuses it. Needs agent.delete at its organization. Deleting a deleted key changes nothing. When cache_clear_status is not ok, a region the change did not reach can act on the earlier state for up to 2 hours.

curl -X DELETE \  "https://engine.sparklogs.app/app-api/workspaces/5e1f0a00-0000-4000-8000-000000000001/ingest-keys/a9e70000-0000-4000-8000-000000000205" \  -H "Authorization: Bearer $SPARKLOGS_TOKEN"

Access

Works with
Signed-in person, Personal token, OAuth token, Workspace token
Scope
fleet:write
Privilege
agent.delete

Needs agent.delete. agent.delete applies at each organization a grant covers and every organization below it. agent.delete also admits deleting and restoring ingest keys.

Behavior

Retry
Safe to repeat: ends in the same state
Audit log
Recorded

Path parameters

workspace_iduuidrequired

The workspace's id.

iduuidrequired

The ingest key's id.

Response 200

cache_clear_statusone of the values below, or null

Sent when the change has to reach every region's cache: how far it got.

  • ok Every region's cache has the change.
  • failed A region could not be reached. The change is saved, and that region can act on the earlier state until its cache expires.
  • disabled This environment does not clear regional caches. The change is saved, and each region can act on the earlier state until its cache expires.
cache_clear_messagestring or null

Sent with a cache_clear_status other than ok: what it means, for a person to read.

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, or one given twice.No
400APP_API_ERR_BAD_PARAMETERSid is not a UUID.No
400APP_API_ERR_BAD_PARAMETERSThe request carries a body other than nothing, null or {}: a delete takes none, and its options are query parameters; parameter names the body's first field, or body.No
403APP_API_ERR_NO_PRIVILEGE_ON_THIS_ORGANIZATIONtoken_scopeno_privilegeThe ingest key does not exist, is in another workspace or is outside your reach, id names a SparkLogs Agent, or you do not hold the privilege at its organization. The same refusal comes when the path names a workspace other than the token's own.No
413APP_API_ERR_BODY_TOO_LARGEThe body is larger than 1 MiB.No

Plus the errors every call can return.

Related

Restore a deleted ingest key​

POST/workspaces/{workspace_id}/ingest-keys/{id}/restore
Preview

Restores a deleted ingest key, so senders using it are accepted again. Needs agent.delete at its organization. Restoring a live key changes nothing. When cache_clear_status is not ok, a region the change did not reach can act on the earlier state for up to 2 hours.

curl -X POST \  "https://engine.sparklogs.app/app-api/workspaces/5e1f0a00-0000-4000-8000-000000000001/ingest-keys/a9e70000-0000-4000-8000-000000000205/restore" \  -H "Authorization: Bearer $SPARKLOGS_TOKEN"

Access

Works with
Signed-in person, Personal token, OAuth token, Workspace token
Scope
fleet:write
Privilege
agent.delete

Needs agent.delete. agent.delete applies at each organization a grant covers and every organization below it. agent.delete also admits deleting and restoring ingest keys.

Behavior

Retry
Safe to repeat: ends in the same state
Audit log
Recorded

Path parameters

workspace_iduuidrequired

The workspace's id.

iduuidrequired

The ingest key's id.

Response 200

cache_clear_statusone of the values below, or null

Sent when the change has to reach every region's cache: how far it got.

  • ok Every region's cache has the change.
  • failed A region could not be reached. The change is saved, and that region can act on the earlier state until its cache expires.
  • disabled This environment does not clear regional caches. The change is saved, and each region can act on the earlier state until its cache expires.
cache_clear_messagestring or null

Sent with a cache_clear_status other than ok: what it means, for a person to read.

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_PARAMETERSThe URL carries a query parameter, which a write does not take: its fields come from its body.No
400APP_API_ERR_BAD_PARAMETERSid is not a UUID.No
400APP_API_ERR_BAD_PARAMETERSThe body is not a JSON object, is not sent as application/json, or names a field: the call takes none.No
403APP_API_ERR_NO_PRIVILEGE_ON_THIS_ORGANIZATIONtoken_scopeno_privilegeThe ingest key does not exist, is in another workspace or is outside your reach, id names a SparkLogs Agent, or you do not hold the privilege at its organization. The same refusal comes when the path names a workspace other than the token's own.No
409APP_API_ERR_CANNOT_RESTORE_PARENT_DELETEDIts organization is deleted.No
413APP_API_ERR_BODY_TOO_LARGEThe body is larger than 1 MiB.No

Plus the errors every call can return.

Related

Move an ingest key​

POST/workspaces/{workspace_id}/ingest-keys/{id}/move
Preview

Moves an ingest key to another organization; data sent with it from then on belongs to the new one. Needs agent.write at its organization and ingest_key.create at the new one. Moving it where it already is changes nothing. When cache_clear_status is not ok, a region the change did not reach can act on the earlier state for up to 2 hours.

curl -X POST \  "https://engine.sparklogs.app/app-api/workspaces/5e1f0a00-0000-4000-8000-000000000001/ingest-keys/a9e70000-0000-4000-8000-000000000204/move" \  -H "Authorization: Bearer $SPARKLOGS_TOKEN" \  -H "Content-Type: application/json" \  -d '{    "organization_id": "0a9e0000-0000-4000-8000-000000000101"  }'

Access

Works with
Signed-in person, Personal token, OAuth token, Workspace token
Scope
fleet:write
Privilege
agent.writeingest_key.create

Needs agent.write at the organization it is in now and ingest_key.create at the organization it moves to. agent.write applies at each organization a grant covers and every organization below it. agent.write also admits changing and moving ingest keys. ingest_key.create applies at each organization a grant covers and every organization below it. ingest_key.create also admits moving a SparkLogs Agent or an ingest key into an organization, with agent.write at the one it leaves.

Behavior

Retry
Safe to repeat: ends in the same state
Audit log
Recorded

Path parameters

workspace_iduuidrequired

The workspace's id.

iduuidrequired

The ingest key's id.

Request body

organization_iduuidrequired

The organization to move it to. Moving needs agent.write at the key's organization and ingest_key.create at this one. Required.

Response 200

cache_clear_statusone of the values below, or null

Sent when the change has to reach every region's cache: how far it got.

  • ok Every region's cache has the change.
  • failed A region could not be reached. The change is saved, and that region can act on the earlier state until its cache expires.
  • disabled This environment does not clear regional caches. The change is saved, and each region can act on the earlier state until its cache expires.
cache_clear_messagestring or null

Sent with a cache_clear_status other than ok: what it means, for a person to read.

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_PARAMETERSThe URL carries a query parameter, which a write does not take: its fields come from its body.No
400APP_API_ERR_BAD_PARAMETERSid is not a UUID.No
400APP_API_ERR_BAD_PARAMETERSThe body is not a JSON object, is not sent as application/json, names a field the call does not take, or a field has the wrong type; parameter names the field, or Content-Type.No
400APP_API_ERR_MISSING_PARAMETERorganization_id is left out.No
400APP_API_ERR_BAD_PARAMETERSorganization_id is not a UUID, or names a deleted organization for a live key.No
403APP_API_ERR_NO_PRIVILEGE_ON_THIS_ORGANIZATIONtoken_scopeno_privilegeThe ingest key or the new organization does not exist or is outside your reach, id names a SparkLogs Agent, or you do not hold agent.write at the key's organization and ingest_key.create at the new one. The same refusal comes when the path names a workspace other than the token's own.No
413APP_API_ERR_BODY_TOO_LARGEThe body is larger than 1 MiB.No

Plus the errors every call can return.

Related

Read an ingest key's secret​

GET/workspaces/{workspace_id}/ingest-keys/{id}/secret
PreviewReturns a secret

Returns the key senders present. It changes nothing. Needs ingest_key.reveal at the ingest key's organization. Every call is recorded in the audit log.

curl -X GET \  "https://engine.sparklogs.app/app-api/workspaces/5e1f0a00-0000-4000-8000-000000000001/ingest-keys/a9e70000-0000-4000-8000-000000000204/secret" \  -H "Authorization: Bearer $SPARKLOGS_TOKEN"

Access

Works with
Signed-in person, Personal token, OAuth token, Workspace token
Scope
any of fleet:deployfleet:write
Privilege
ingest_key.reveal

Needs ingest_key.reveal. ingest_key.reveal applies at each organization a grant covers and every organization below it.

Behavior

Retry
Safe to send again
Audit log
Recorded

Path parameters

workspace_iduuidrequired

The workspace's id.

iduuidrequired

The ingest key's id.

Response 200

keystringrequired

The key a sender presents to send log data.

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, or one given twice.No
400APP_API_ERR_BAD_PARAMETERSid is not a UUID.No
403APP_API_ERR_NO_PRIVILEGE_ON_THIS_ORGANIZATIONtoken_scopeno_privilegeYou do not hold ingest_key.reveal at its organization, or it is missing, outside your reach or a SparkLogs Agent. The same refusal comes when the path names a workspace other than the token's own.No
409APP_API_ERR_CONFLICTThe ingest key is deleted: restore it first.Read first

Plus the errors every call can return.

Related

Replace an ingest key's secret​

POST/workspaces/{workspace_id}/ingest-keys/{id}/rotate
PreviewReturns a secretDestructive

Replaces the key senders present with a new one and returns it; senders still using the old key are refused from then on, and cache_clear_status says whether every region refuses it. Needs ingest_key.rotate at the ingest key's organization. Every call is recorded in the audit log. When cache_clear_status is not ok, a region the change did not reach can act on the earlier state for up to 2 hours.

curl -X POST \  "https://engine.sparklogs.app/app-api/workspaces/5e1f0a00-0000-4000-8000-000000000001/ingest-keys/a9e70000-0000-4000-8000-000000000204/rotate" \  -H "Authorization: Bearer $SPARKLOGS_TOKEN"

Access

Works with
Signed-in person, Personal token, OAuth token, Workspace token
Scope
any of fleet:deployfleet:write
Privilege
ingest_key.rotate

Needs ingest_key.rotate. ingest_key.rotate applies at each organization a grant covers and every organization below it.

Behavior

Retry
Read before sending again
Audit log
Recorded

Path parameters

workspace_iduuidrequired

The workspace's id.

iduuidrequired

The ingest key's id.

Response 200

keystringrequired

The new key a sender presents to send log data.

cache_clear_statusone of the values belowrequired

Whether every region refuses the old key.

  • ok Every region refuses the old key.
  • failed A region could not be reached. The old key can keep working there until its cache expires.
  • disabled This environment does not clear regional caches. The old key can keep working until each region's cache expires.
cache_clear_messagestring or null

Sent with a cache_clear_status other than ok: what it means, for a person to read.

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_PARAMETERSThe URL carries a query parameter, which a write does not take: its fields come from its body.No
400APP_API_ERR_BAD_PARAMETERSid is not a UUID.No
400APP_API_ERR_BAD_PARAMETERSThe body is not a JSON object, is not sent as application/json, or names a field: the call takes none.No
403APP_API_ERR_NO_PRIVILEGE_ON_THIS_ORGANIZATIONtoken_scopeno_privilegeYou do not hold ingest_key.rotate at its organization, or it is missing, outside your reach or a SparkLogs Agent. The same refusal comes when the path names a workspace other than the token's own.No
409APP_API_ERR_CONFLICTThe ingest key is deleted: restore it first.Read first
413APP_API_ERR_BODY_TOO_LARGEThe body is larger than 1 MiB.No

Plus the errors every call can return.

Related