firehose

Create Firehose source target

Changed on

Create or update a workspace Firehose source target.

Use this Firehose operation to query or observe source-backed civic signals for an authenticated workspace. Preserve workspace, usage, signal, and evidence context so billing and trust stay tied to the query that produced the data.

post/api/firehose/source-targets

Request

  • Base URL: https://atlas.rebuildingus.org
  • URL: https://atlas.rebuildingus.org/api/firehose/source-targets
  • Auth: none declared

Headers

x-api-keystring nullable

Request body

cadence_secondsinteger

cadence seconds for this firehose source target.

coverage_target_idstring required

coverage target id for this firehose source target.

enabledboolean

enabled for this firehose source target.

issuesstring[] required

issues for this firehose source target.

labelstring required

label for this firehose source target.

origin_notestring nullable

origin note for this firehose source target.

placesstring[] required

places for this firehose source target.

prioritystring

priority for this firehose source target.

public_route_enabledboolean

public route enabled for this firehose source target.

safety_policystring

safety policy for this firehose source target.

source_classstring required

source class for this firehose source target.

source_kindstring required

source kind for this firehose source target.

urlstring required

url for this firehose source target.

Response

Successful Response

cadence_secondsinteger required

cadence seconds for this firehose source target.

content_hashstring nullable required

content hash for this firehose source target.

coverage_target_idstring required

coverage target id for this firehose source target.

created_atstring required

created at for this firehose source target.

created_bystring required

created by for this firehose source target.

enabledboolean required

enabled for this firehose source target.

etagstring nullable required

etag for this firehose source target.

idstring required

id for this firehose source target.

issuesstring[] required

issues for this firehose source target.

labelstring required

label for this firehose source target.

last_checked_atstring nullable required

last checked at for this firehose source target.

last_errorstring nullable required

last error for this firehose source target.

last_http_statusinteger nullable required

last http status for this firehose source target.

last_modifiedstring nullable required

last modified for this firehose source target.

last_success_atstring nullable required

last success at for this firehose source target.

org_idstring required

org id for this firehose source target.

originstring required

origin for this firehose source target.

origin_notestring nullable required

origin note for this firehose source target.

placesstring[] required

places for this firehose source target.

prioritystring required

priority for this firehose source target.

public_route_enabledboolean required

public route enabled for this firehose source target.

safety_policystring required

safety policy for this firehose source target.

source_classstring required

source class for this firehose source target.

source_kindstring required

source kind for this firehose source target.

updated_atstring required

updated at for this firehose source target.

urlstring required

url for this firehose source target.

Changes

  • 6ea72ce93d40Revision changes
    • warning

      deleted the header request parameter x-atlas-actor-email

    • warning

      deleted the header request parameter x-atlas-actor-id

    • warning

      deleted the header request parameter x-atlas-internal-secret

    • warning

      deleted the header request parameter x-atlas-organization-id

  • 5f6dc82dbd8eRevision changes
    • info

      endpoint added