Skip to main content
POST
/
issues
JavaScript
import Antimetal from '@antimetal/sdk';

const client = new Antimetal({
  apiKey: process.env['ANTIMETAL_API_KEY'], // This is the default and can be omitted
});

const issue = await client.issues.create({
  description: 'x',
  environment: 'x',
  title: 'x',
});

console.log(issue.uuid);
{
  "uuid": "<string>",
  "number": 4503599627370495,
  "status": "investigating",
  "title": "<string>",
  "description": "<string>",
  "severity": "low",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "triggeredAt": "2023-11-07T05:31:56Z",
  "latestVersion": 4503599627370496,
  "environment": "<string>"
}

Authorizations

​
Authorization
string
header
required

API key authentication via Bearer token

Headers

​
Antimetal-Version
string
default:2026-03-17

The API version to use. Defaults to the latest stable version if omitted. Pin to the version string in this document's info.version field to opt into exactly this version's schema.

Example:

"2026-03-17"

Body

application/json
​
title
string
required

Issue title (human-readable summary)

Required string length: 1 - 500
​
description
string
required

Detailed description of the issue

Minimum string length: 1
​
environment
string
required

Environment where the issue occurred (e.g., production, staging)

Minimum string length: 1
​
severity
enum<string>

Issue severity level (defaults to MEDIUM if not specified)

Available options:
low,
medium,
high
​
triggeredAt
string<date-time>

ISO 8601 timestamp when the issue was triggered (defaults to current time)

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
​
context
object

Additional context metadata for enriching the investigation

Response

Issue created successfully

​
uuid
string
required

Issue unique identifier

​
number
integer
required

Issue number (scoped per-organization)

Required range: 0 < x <= 9007199254740991
​
status
enum<string>
required

Current issue status

Available options:
investigating,
ready_to_fix,
resolved,
muted
​
title
string
required

Issue title

​
description
string
required

Issue description

​
severity
enum<string>
required

Issue severity level

Available options:
low,
medium,
high
​
createdAt
string<date-time>
required

Date and time the issue was created

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
​
updatedAt
string<date-time>
required

Date and time the issue was last updated

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
​
triggeredAt
string<date-time>
required

Timestamp when the issue was triggered

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
​
latestVersion
integer
required

Most recent version of this issue

Required range: 1 <= x <= 9007199254740991
​
environment
string

Environment where issue occurred