Link

Create Deployment (Account)

Method URL POST http://<report_container_url>:<container_port>/report/v1/deployment
HTTP Method POST
Content Type application/json

Request Arguments

Required Arguments Data Type How To Use
action string Must be "create_account"
customer string Unique identifier for this customer (a-z0-9). Must start with alpha character.
deployment_name string String to identify ZE deployment (a-z0-9)
Optional Arguments Data Type How to Use
email string Email of primary contact for this Customer
gpt3 boolean Default is False
ingest_limit integer Ingest limit in Bytes per day (default 1000000000000)
ingest_node string Name of ingest node to handle this account. Defaults to least utilized node.
slack_webhook string Per customer Slack webhook for incident notifications (no default)

Example Request Payload

{
  "action": "create_account",
  "customer": "acme",
  "deployment_name": "trial",
  "email": "wiley@acme.com",
  "ingest_limit": 1000000000000,
  "ingest_node" : "ingest2",
  "slack_webhook": "https://hooks.slack.com/services/webhook",
}

Example Response Payload

{
  "data": {
    "action": "create_account",
    "customer": "acme",
    "deployment_name": "trial",
    "email": "wiley@acme.com",
    "ingest_limit": 1000000000000,
    "ingest_node" : "ingest2",
    "retention_days": 3,
    "slack_webhook": "https://hooks.slack.com/services/webhook",
    "zapi_token": "7CBC9BD0FA7F98026A1404ED9AB82B9B4734D554",
    "deployment_id" : "acme_trial"
  },
  "error": {
    "code": 202,
    "message": "202 Accepted"
  }
}