Support (Beta)

File bugs and feature requests reported by a user

File a bug the user reported

post

Files an ARS Bug from a user's report. The agent files without asking the user to confirm, so the team hears about defects the user would not have bothered to report. Repeats are triage's job to merge; each organization is capped per day.

Path parameters

org_idstring · uuidRequired

Body

summarystring · min: 1 · max: 200Required

One-line ticket title.

user_verbatimstring · min: 1 · max: 2000Required

The user's own words, quoted. Do not paraphrase.

what_happenedstring · min: 1 · max: 4000Required

The error or wrong behavior the user saw.

steps_to_reproducestring · min: 1 · max: 4000Required

Numbered steps an engineer can follow.

expected_behaviorstring · min: 1 · max: 4000Required

What the user expected instead.

app_urlstring · max: 500 · nullableOptional

App URL where this happened, if known.

Default: null

providerstring · enum · nullableOptional

Cloud provider involved, if relevant.

Default: nullPossible values:

Responses

200

OK

application/json

statusstringRequired

created when a ticket was filed, rate_limited when the org hit its daily cap, not_filed when filing is disabled in this environment.

ticket_keystringOptional

ARS key of the filed ticket.

ticket_urlstringOptional

Link to the filed ticket.

reasonstringOptional

Why nothing was filed.

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

405

Method not allowed

application/json

409

Conflict

application/json

422

Unprocessable Content

application/json

500

Internal server error

application/json

default

Default error response

application/json

post/beta/v1/org/{org_id}/support/bug-reports

POST /beta/v1/org/{org_id}/support/bug-reports HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 153

{
  "summary": "text",
  "user_verbatim": "text",
  "what_happened": "text",
  "steps_to_reproduce": "text",
  "expected_behavior": "text",
  "app_url": "text",
  "provider": "aws"
}

{
  "status": "text",
  "ticket_key": "text",
  "ticket_url": "text",
  "reason": "text"
}

File a feature request the user asked for

post

Files an ARS Feature Request from a user's ask. Call this only when the user wants a capability the platform does not have. Repeats are triage's job to merge; each organization is capped per day.

Path parameters

org_idstring · uuidRequired

Body

summarystring · min: 1 · max: 200Required

One-line ticket title.

user_verbatimstring · min: 1 · max: 2000Required

The user's own words, quoted. Do not paraphrase.

problemstring · min: 1 · max: 4000Required

The problem this solves, and who hits it.

desired_behaviorstring · min: 1 · max: 4000Required

What the user wants, high level. Not a spec.

business_valuestring · min: 1 · max: 4000Required

Why it matters: friction removed, time saved, deal context.

Responses

200

OK

application/json

statusstringRequired

created when a ticket was filed, rate_limited when the org hit its daily cap, not_filed when filing is disabled in this environment.

ticket_keystringOptional

ARS key of the filed ticket.

ticket_urlstringOptional

Link to the filed ticket.

reasonstringOptional

Why nothing was filed.

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

405

Method not allowed

application/json

409

Conflict

application/json

422

Unprocessable Content

application/json

500

Internal server error

application/json

default

Default error response

application/json

post/beta/v1/org/{org_id}/support/feature-requests

POST /beta/v1/org/{org_id}/support/feature-requests HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 108

{
  "summary": "text",
  "user_verbatim": "text",
  "problem": "text",
  "desired_behavior": "text",
  "business_value": "text"
}

{
  "status": "text",
  "ticket_key": "text",
  "ticket_url": "text",
  "reason": "text"
}