Docs Menu
Docs Home
/
MongoDB Atlas
/
Atlas CLI
/
Commands
/
api
/
resourcePolicies

atlas api resourcePolicies deleteAtlasResourcePolicy

On this page

  • Syntax
  • Options
  • Inherited Options
  • Examples

Public Preview: please provide feedback at: Delete one Atlas Resource Policy for an org.

This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Resource-Policies/operation/deleteAtlasResourcePolicy.

For more information and examples, see the referenced API documentation linked above.

Syntax

Command Syntax
atlas api resourcePolicies deleteAtlasResourcePolicy [options]

Options

Name
Type
Required
Description

--envelope

envelope

false

Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.

-h, --help

false

help for deleteAtlasResourcePolicy

--orgId

string

true

Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all organizations to which the authenticated user has access.

--output

string

false

preferred api format, can be ["json", go-template] This value defaults to "json".

--output-file

string

false

file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip)

--pretty

false

Flag that indicates whether the response body should be in the prettyprint format.

--resourcePolicyId

string

true

Unique 24-hexadecimal digit string that identifies an atlas resource policy.

--version

string

false

api version to use when calling the api call [options: "2024-08-05"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-08-05".

Inherited Options

Name
Type
Required
Description

-P, --profile

string

false

Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.

Examples

atlas api resourcePolicies deleteAtlasResourcePolicy --version 2024-08-05 --orgId 4888442a3354817a7320eb61 --resourcePolicyId 32b6e34b3d91647abb20e7b8

Back

createAtlasResourcePolicy

Next

getAtlasResourcePolicies