Skip to main content
POST
/
ingest
/
{dataset-id}
cURL
curl --request POST \
  --url https://{axiom-domain}/v1/ingest/{dataset-id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '"<string>"'
{
  "blocksCreated": 123,
  "failed": 123,
  "ingested": 123,
  "processedBytes": 123,
  "walLength": 123,
  "failures": [
    {
      "error": "<string>",
      "timestamp": "2023-11-07T05:31:56Z"
    }
  ]
}
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 deploymentBase domain of ingest API endpoint
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.

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

​
X-Axiom-CSV-Fields
string[]

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

An optional JSON encoded object with additional labels to add to all events in the request

Path Parameters

​
dataset-id
string
required

Query Parameters

​
timestamp-field
string

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

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

The delimiter to use when parsing CSV data. If not specified, the default delimiter is ,.

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.

Response

200 - application/json

IngestResult

​
blocksCreated
integer<uint32>
required
​
failed
integer<uint64>
required
​
ingested
integer<uint64>
required
​
processedBytes
integer<uint64>
required
​
walLength
integer<uint32>
required
​
failures
object[]