Source

Load a source

Loads the meta data for a source of data

  • Requires the action org:LoadSource on the organization
get/api/v1/org/{orgUID}/source/{sourceUID}

Request

  • Base URL: https://api.prod.spyderbat.com
  • URL: https://api.prod.spyderbat.com/api/v1/org/{orgUID}/source/{sourceUID}
  • Auth: HTTP bearer

Path parameters

orgUIDstring required
sourceUIDstring required

Response

OK

activeinteger

Is this source considered active

agent_uidstring

The agent this source is associated with

archivedboolean

Is the source archived?

descriptionstring

User supplied description of the source

last_datastring date-time
last_ingest_chunk_end_timestring date-time

The end of the last chunk ingested from the agent

namestring

User supplied name of the source

org_uidstring

The org this source is associated with

resource_namestring

Resource name used for RBAC

runtime_descriptionstring

Description of the runtime of the source

tagsstring[]

User supplied tags

typestring

Type of source

uidstring required

The UID of the source

valid_fromstring date-time

Valid from date, the first date this object was valid

valid_tostring date-time

Valid to date, the date this object is valid to

Changes

No recorded changes to this operation across all 1 revision of this API.