---
title: "Create Exception Instance"
method: POST
path: "/exceptions"
tags: ["Exception Instance"]
---

# Create Exception Instance

`POST /exceptions`

## Request

- Base URL: `https://oneuptime.com/api`
- URL: `https://oneuptime.com/api/exceptions`
- Auth: API key in header `APIKey`
- TypeScript: <https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/docs/exceptions/post.ts> (a function with typed inputs; its response is checked against the schema)

Endpoint to create a new Exception Instance

## Request body

- object
  - `data` ExceptionItemV3CreateSchema, required: Create schema for ExceptionItemV3
    - `projectId` string, uuid: ID of project
    - `primaryEntityId` string, uuid, required: ID of the resource the exception belongs to (Service / Host / DockerHost / KubernetesCluster / Monitor — disambiguated by primaryEntityType)
    - `primaryEntityType` string: Discriminator for primaryEntityId — tells the read side which resource table to dispatch to
    - `time` string, date-time, required: When was the log created?
    - `timeUnixNano` union, required: When was the log created?
      - number
      - string
    - `exceptionType` string: Exception Type
    - `stackTrace` string: Exception Stack Trace
    - `message` string: Exception Message
    - `spanStatusCode` number: Span Status Code
    - `escaped` boolean: Exception Escaped
    - `traceId` string: ID of the trace
    - `spanId` string: ID of the span
    - `sessionId` string: Session replay session ID this exception fired in; '' when there was no browser session in context.
    - `userId` string: The user this exception happened to: the occurrence's user.id, enduser.id or enduser.pseudo.id attribute; '' when it names no user.
    - `fingerprint` string, required: Fingerprint of the exception
    - `spanName` string: Name of the span
    - `release` string: Service version / release from service.version resource attribute
    - `environment` string: Deployment environment from deployment.environment resource attribute
    - `parsedFrames` string: Stack trace parsed into structured frames (JSON array)
    - `attributes` object: Attributes
    - `attributeKeys` string[]: Attribute keys extracted from attributes
    - `entityKeys` string[]: Stable keys of every OpenTelemetry entity (service, host, k8s.pod, container, ...) this signal belongs to. A superset that includes the primary entity. Enables cross-cutting membership queries via has(entityKeys, :key).
    - `serviceEntityKey` string: Scalar entity key for this entity type (see entityKeys); '' when the resource has no entity of this type.
    - `hostEntityKey` string: Scalar entity key for this entity type (see entityKeys); '' when the resource has no entity of this type.
    - `k8sPodEntityKey` string: Scalar entity key for this entity type (see entityKeys); '' when the resource has no entity of this type.
    - `k8sNodeEntityKey` string: Scalar entity key for this entity type (see entityKeys); '' when the resource has no entity of this type.
    - `k8sClusterEntityKey` string: Scalar entity key for this entity type (see entityKeys); '' when the resource has no entity of this type.
    - `containerEntityKey` string: Scalar entity key for this entity type (see entityKeys); '' when the resource has no entity of this type.

## Response `201`

Created successfully

- object
  - `data` ExceptionItemV3ReadSchema
    - `projectId` string, required: Project ID
    - `primaryEntityId` string, required: Service ID
    - `primaryEntityType` string: Service Type
    - `time` string: Time
    - `timeUnixNano` string: Time (in Unix Nano)
    - `exceptionType` string: Exception Type
    - `stackTrace` string: Stack Trace
    - `message` string: Exception Message
    - `spanStatusCode` number: Span Status Code
    - `escaped` boolean: Exception Escaped
    - `traceId` string: Trace ID
    - `spanId` string: Span ID
    - `sessionId` string: Session ID
    - `userId` string: User ID
    - `fingerprint` string, required: Fingerprint
    - `spanName` string: Span Name
    - `release` string: Release
    - `environment` string: Environment
    - `parsedFrames` string: Parsed Stack Frames
    - `attributes` string: Attributes
    - `attributeKeys` string[]: Attribute Keys
    - `entityKeys` string[]: Entity Keys
    - `serviceEntityKey` string: Service Entity Key
    - `hostEntityKey` string: Host Entity Key
    - `k8sPodEntityKey` string: Kubernetes Pod Entity Key
    - `k8sNodeEntityKey` string: Kubernetes Node Entity Key
    - `k8sClusterEntityKey` string: Kubernetes Cluster Entity Key
    - `containerEntityKey` string: Container Entity Key

## Other responses

- `400`: Bad request. This response indicates that the request was malformed or contained invalid data.
- `401`: Unauthorized. This response indicates that the request requires user authentication.
- `402`: Payment Required. This response indicates that the request requires payment or a valid subscription.
- `403`: Forbidden. This response indicates that the server understood the request, but refuses to authorize it.
- `405`: Project not found. This response indicates that the requested project does not exist or is not accessible.
- `408`: Request Timeout. This response indicates that the server timed out waiting for the request.
- `415`: Unable to reach server. This response indicates that the server is currently unreachable or down.
- `422`: Not authorized. This response indicates that the user does not have permission to access the requested resource.
- `500`: Internal Server Error. This response indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.

---

[API](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification.md) - [All operations](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/llms.txt) - [OpenAPI document](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/revisions/ba3307d00304?raw)