atlas api programmaticApiKeys createApiKeyAccessList

string

true

Unique 24-hexadecimal digit string that identifies this organization API key for which you want to create a new access list entry.

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.

string

false

path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both.

false

help for createApiKeyAccessList

false

Flag that indicates whether the response returns the total number of items (totalCount) in the response.

int

false

Number of items that the response returns per page.

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.

string

false

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

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)

int

false

Number of the page that displays the current set of the total objects that the response returns.

false

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

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".