System

Create an archive

Create new archive of the given kind

post/system/archives/{archiveKind}

Request

Base URL
https://rudder.example.com/rudder/api/latest
Auth
API key in header X-API-Token
TypeScript
https://skmtc.dev/rudder/apis/rudder-api/docs/system/archives/:archiveKind/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

archiveKind'full' | 'groups' | 'rules' | 'directives' | 'parameters' required

Example:full

Type of archive to make

Response

Success

result'success' | 'error' required

Result of the request

action'archiveFull' | 'archiveGroups' | 'archiveRules' | 'archiveDirectives' | 'archiveParameters' required

The kind of the archive

Example response

{
  "action": "archiveFull",
  "data": {
    "full": {
      "commiter": "Rudder system account",
      "gitCommit": "546de1b211ecc5b7ca295abac2191bc6bb05d44e",
      "id": "2019-09-17_16-06-15.255"
    }
  }
}

Changes

No recorded changes to this operation across all 7 revisions of this API.