atlas api programmaticApiKeys getApiKeyAccessList

On this page

experimental: Returns one access list entry for the specified organization API key.

Resources require all API requests originate from IP addresses on the API access list. To use this resource, the requesting API Key must have the Organization Member role. This command is invoking the endpoint with OperationID: 'getApiKeyAccessList'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/getApiKeyAccessList

Syntax

Command Syntax

atlas api programmaticApiKeys getApiKeyAccessList [options]

Name	Type	Required	Description
--apiUserId	string	true	unique 24-hexadecimal digit string that identifies this organization API key for which you want to return access list entries
--envelope		false	flag that indicates whether Application wraps the response in an envelope JSON object
-h, --help		false	help for getApiKeyAccessList
--ipAddress	string	true	one IP address or multiple IP addresses represented as one CIDR block to limit requests to API resources in the specified organization
--orgId	string	true	unique 24-hexadecimal digit string that identifies the organization that contains your projects
--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
--version	string	false	api version to use when calling the api call [options: "2023-01-01"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2023-01-01".

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.

Back

getApiKey

listApiKeyAccessListsEntries