Audit

Query centralized audit log

get

Retrieve audit trail entries across registered audit sources. Requires Owner role. Use the approval compliance API for SOX approval exports.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

sourcestring · enumOptional

Audit source to query

Example: integrationPossible values:

actionstringOptional

Filter by action. Prefix match without dot (integration) or exact action (integration.created).

Example: integration.created

actorstringOptional

Filter by actor email

Example: dev@flxbl.io

repositoryIdentifierstringOptional

Filter by repository identifier where the audit source exposes one

Example: flxbl-io/sf-core

entityIdstringOptional

Filter by audited entity identifier

Example: c7a1d1fd-8887-4ec7-b72d-b0c3611f7c43

fromstringOptional

ISO 8601 start timestamp, inclusive

tostringOptional

ISO 8601 end timestamp, exclusive

limitnumber · max: 1000Optional

Maximum entries to return

Default: 50

offsetnumberOptional

Offset into the result set

Default: 0

Responses

200

Audit log entries returned

No content

403

Forbidden - Requires role: owner

get/sfp/api/audit

GET /sfp/api/audit HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Start an async audit CSV export

post

Creates an owner-only audit CSV export job. Approval compliance exports remain under the approval compliance API.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

sourcestring · enumOptional

Audit source to export

Example: integrationPossible values:

actionstringOptional

Filter by action. Prefix match without dot (integration) or exact action (integration.created).

Example: integration.created

actorstringOptional

Filter by actor email

Example: dev@flxbl.io

repositoryIdentifierstringOptional

Filter by repository identifier where the audit source exposes one

Example: flxbl-io/sf-core

entityIdstringOptional

Filter by audited entity identifier

fromstringOptional

ISO 8601 start timestamp, inclusive

tostringOptional

ISO 8601 end timestamp, exclusive

fileNamestringOptional

Download filename. Defaults to a generated audit-export filename.

Responses

201

Audit export job created

No content

403

Forbidden - Requires role: owner

post/sfp/api/audit/exports

POST /sfp/api/audit/exports HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 182

{
  "source": "integration",
  "action": "integration.created",
  "actor": "dev@flxbl.io",
  "repositoryIdentifier": "flxbl-io/sf-core",
  "entityId": "text",
  "from": "text",
  "to": "text",
  "fileName": "text"
}

No content

Get audit export status

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Audit export id

Responses

200

Audit export record returned

No content

403

Forbidden - Requires role: owner

get/sfp/api/audit/exports/{id}

GET /sfp/api/audit/exports/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Download a completed audit export CSV

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Audit export id

Responses

200

Streams the completed audit CSV through the SFP API

No content

403

Forbidden - Requires role: owner

get/sfp/api/audit/exports/{id}/download

GET /sfp/api/audit/exports/{id}/download HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get the authenticated audit export CSV download URL

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Audit export id

Responses

200

Authenticated SFP API download URL returned

No content

403

Forbidden - Requires role: owner

get/sfp/api/audit/exports/{id}/download-url

GET /sfp/api/audit/exports/{id}/download-url HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Fetch audit export rows for the worker (internal)

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Query parameters

cursorCreatedAtstringOptional

Cursor created_at value from the previous page

cursorIdstringOptional

Cursor row id from the previous page

limitnumber · max: 1000Optional

Maximum rows to return

Default: 1000

Responses

403

Forbidden - Requires role: application

No content

get/sfp/api/audit/internal/exports/{id}/rows

GET /sfp/api/audit/internal/exports/{id}/rows HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

403

Forbidden - Requires role: application

No content

Mark an audit export complete (internal)

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Body

objectKeystringRequired

S3 object key containing the completed CSV

fileNamestringRequired

CSV filename to present to users

rowCountnumberRequired

Number of exported rows

fileSizeBytesnumberRequired

Uploaded object size in bytes

contentTypestringOptional

Object content type

Default: text/csv

Responses

403

Forbidden - Requires role: application

No content

post/sfp/api/audit/internal/exports/{id}/complete

POST /sfp/api/audit/internal/exports/{id}/complete HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 94

{
  "objectKey": "text",
  "fileName": "text",
  "rowCount": 1,
  "fileSizeBytes": 1,
  "contentType": "text/csv"
}

403

Forbidden - Requires role: application

No content

Mark an audit export failed (internal)

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Body

errorstringRequired

Failure reason

Responses

403

Forbidden - Requires role: application

No content

post/sfp/api/audit/internal/exports/{id}/fail

POST /sfp/api/audit/internal/exports/{id}/fail HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "error": "text"
}

403

Forbidden - Requires role: application

No content

Clean up expired audit exports (internal)

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

batchSizenumber · max: 1000Optional

Maximum expired export records to clean up

Default: 100

Responses

403

Forbidden - Requires role: application

No content

post/sfp/api/audit/internal/exports/cleanup

POST /sfp/api/audit/internal/exports/cleanup HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "batchSize": 100
}

403

Forbidden - Requires role: application

No content

Last updated 3 hours ago

Was this helpful?