DeleteSecurityPolicy

client.securityPolicies.delete(, ?): SecurityPolicyDeleteResponse

POST/gitpod.v1.SecurityService/DeleteSecurityPolicy

Deletes a security policy.

Use this method to:

Remove obsolete security policies
Clean up unused policy definitions

Examples

Delete security policy:

Permanently removes a security policy.
```
securityPolicyId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
```

ParametersExpand Collapse

body: SecurityPolicyDeleteParams { securityPolicyId }

securityPolicyId?: string

formatuuid

ReturnsExpand Collapse

SecurityPolicyDeleteResponse = unknown

DeleteSecurityPolicy

import Gitpod from '@gitpod/sdk';

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

const securityPolicy = await client.securityPolicies.delete({
  securityPolicyId: 'd2c94c27-3b76-4a42-b88c-95a85e392c68',
});

console.log(securityPolicy);

{}

Returns Examples

{}