Ingest data to edge deployment

POST/v1/ingest/{dataset-id}

Warning

Use this endpoint to ingest data into a specific edge deployment. For more information, see Ingest data and Edge deployments.

The base domain for this endpoint is the base domain of the edge deployment where you want to ingest data.

Edge deployment	Base domain for ingest and query
`US East 1 (AWS)`	`us-east-1.aws.edge.axiom.co`
`EU Central 1 (AWS)`	`eu-central-1.aws.edge.axiom.co`

This endpoint only supports API tokens. Personal access tokens (PATs) aren't supported. For more information, see Tokens.

Parameters

Property	Type	Location	Description
`dataset-id`	`string`Required	`path`
`timestamp-field`	`string`	`query`	The name of the field to use as the timestamp. If not specified, the timestamp will be the time the event was received by Axiom.
`timestamp-format`	`string`	`query`	The date-time format of the timestamp field. The reference time is `Mon Jan 2 15:04:05 -0700 MST 2006`, as specified in https://pkg.go.dev/time/?tab=doc#Parse
`csv-delimiter`	`string`	`query`	The delimiter to use when parsing CSV data. If not specified, the default delimiter is `,`.
`X-Axiom-CSV-Fields`	`string[]`	`header`	A list of optional comma separated fields to use for CSV ingestion. If not specified, the first line of the CSV will be used as the field names.
`X-Axiom-Event-Labels`	`string`	`header`	An optional JSON encoded object with additional labels to add to all events in the request

Body

Data you want to send to Axiom. Supported formats: JSON, NDJSON, CSV. Upload the data in a file or send it in the payload of the request.

application/jsonapplication/nd-jsontext/csvapplication/x-ndjson

Request

curl -X POST 'https://{axiom-domain}/v1/ingest/DATASET_ID' \
  -H 'Authorization: Bearer API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"message":"hello from Axiom","status":200}'

Try itRun this request against your Axiom organization

Credentials stay in this browser tab and are only sent to Axiom when you run the request.

API token Requireddataset-id pathRequiredtimestamp-field querytimestamp-format querycsv-delimiter queryRequest body application/json

Response

200IngestResult

application/json

Property	Type	Description
`blocksCreated`	`integer<uint32>`Required
`failed`	`integer<uint64>`Required
`failures`	`object[]`
`error`	`string`Required
`timestamp`	`string<date-time>`Required
`ingested`	`integer<uint64>`Required
`processedBytes`	`integer<uint64>`Required
`walLength`	`integer<uint32>`Required