DELETE/orgs/{org}/code-security/configurations/{configuration_id}

Delete a code security configuration

Deletes the desired code security configuration from an organization. Repositories attached to the configuration will retain their settings but will no longer be associated with the configuration.

The authenticated user must be an administrator or security manager for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the write:org scope to use this endpoint.

RetriesRetries up to 2×, 500ms backoff, 30s timeout.

2 parameters

orgstringrequired

The organization name. The name is not case sensitive.

configuration_idintegerrequired

The unique identifier of the code security configuration.

5 status codes

204A header with no content is returned.

400Bad Request

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

403Forbidden

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

404Resource not found

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

409Conflict

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

Error handling

A 400 is returned: Bad Request. A 403 is returned: Forbidden. A 404 is returned: Resource not found. A 409 is returned: Conflict.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  auth: { bearer: process.env.API_TOKEN },
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.configurations.delete({
  org: "acme-inc",
  configurationId: "c0a80123-4567-89ab-cdef-0123456789ab",
});

{
  "message": "This is an example message.",
  "documentation_url": "https://example.com",
  "url": "https://example.com",
  "status": "active"
}

Request

Response

Errors