---
title: "POST functional_profiles cancel"
method: POST
path: "/api/v1/functional_profiles/{id}/cancel"
---

# POST functional_profiles cancel

`POST /api/v1/functional_profiles/{id}/cancel`

## Request

- Base URL: `https://app.onecodex.com`
- URL: `https://app.onecodex.com/api/v1/functional_profiles/{id}/cancel`
- Auth: API key in header `X-API-Key`

## Path parameters

- `id` string, required

## Response `200`

OK

- FunctionalProfiles
  - `$uri` string, required
  - `complete` boolean
  - `created_at` string, date-time, required: Timestamp for when the object was created on the One Codex platform, encoded as a [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) timestamp.
  - `error_msg` string, nullable: The error message from the analysis, if it failed.
  - `job` object, required: A reference to the versioned job underlying the analysis, e.g., `{"$ref": "/api/v1/jobs/d512cb556241440f"}`.
    - `__DOLLAR_REF__` string, uri
  - `job_args` object: The arguments passed into this analysis (can be `null`).
  - `results_uri` string, nullable, required: URI for direct download of results
  - `sample` object, required: A reference to the sample underlying the analysis, e.g., `{"$ref": "/api/v1/sample/0ee172af60e84f61"}`.
    - `__DOLLAR_REF__` string, uri
  - `success` boolean
  - `updated_at` string, date-time, nullable: Timestamp for when the object was last updated on the One Codex platform, encoded as a [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) timestamp.

## Changes

- **2026-11-03** `3be5a5f9bf7d`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/onecodex/apis/one-codex-api-v1/changes/api/v1/functional_profiles/:id/cancel/post.md)

---

[API](https://skmtc.dev/onecodex/apis/one-codex-api-v1.md) - [All operations](https://skmtc.dev/onecodex/apis/one-codex-api-v1/llms.txt) - [OpenAPI document](https://skmtc.dev/onecodex/apis/one-codex-api-v1/revisions/3be5a5f9bf7d?raw)