Skip to content

Reference

DataStax Astra DevOps

Connect the DataStax Astra DevOps API to Alter Vault for secure API access

Use a DataStax Astra application token to manage databases and keyspaces through the Astra DevOps API without exposing the token in code.

PropertyValue
Provider IDastra-devops
CategoryDatabase
Credential TypeApplication Token
API hostapi.astra.datastax.com (fixed)

Log in to the Astra Portal

Log in to the Astra Portal.

Generate an organization token

Open Settings > Tokens and generate a token with an organization-level role (Database Administrator or higher). A database-scoped token cannot manage databases.

Copy the token

Copy the application token (starts with AstraCS:) — it is only shown once.

Open the Developer Portal

Go to portal.alterauth.com and navigate to the application.

Add DataStax Astra DevOps

Go to Managed Secrets > Add Provider > DataStax Astra DevOps.

Enter credentials

Paste the Application Token into the credential field. The token is verified against the Astra DevOps API when you save.

Save

Click Save. You’ll receive a grant_id to use with the SDK.

response = await alter_app.request(
HttpMethod.GET,
"https://api.astra.datastax.com/v2/databases",
grant_id="YOUR_GRANT_ID",
)
  • The token is injected as Authorization: Bearer at the fixed host https://api.astra.datastax.com.
  • Querying documents or vectors uses a different provider and a different header — see DataStax Astra DB (Data API).

Alter policy rules can target these attested operations and families for operation-level and parameter-aware controls. The catalog covers the complete published DevOps API surface — the same application token reaches every operation below, so destructive (delete) and administrative (admin) families are all governable.

Operation IDFamiliesMethodProvider path
GetAccessListTemplateadmin, readPOST/v2/access-list/template
ValidateAccessListadmin, readPOST/v2/access-list/validate
GetAllAccessListsForOrganizationadmin, readGET/v2/access-lists
listAvailableRegionsreadGET/v2/availableRegions
getClientsForOrgadmin, readGET/v2/clientIdSecrets
generateTokenForClientadmin, writePOST/v2/clientIdSecrets
deleteTokenForClientadmin, deleteDELETE/v2/clientIdSecrets/{clientId}
getCurrentOrganizationreadGET/v2/currentOrg
listDatabasesreadGET/v2/databases
createDatabaseadmin, writePOST/v2/databases
getDatabasereadGET/v2/databases/{databaseID}
DeleteAddressesOrAccessListForDatabaseadmin, deleteDELETE/v2/databases/{databaseID}/access-list
GetAccessListForDatabaseadmin, readGET/v2/databases/{databaseID}/access-list
UpdateAccessListForDatabaseadmin, writePATCH/v2/databases/{databaseID}/access-list
AddAddressesToAccessListForDatabaseadmin, writePOST/v2/databases/{databaseID}/access-list
UpsertAccessListForDatabaseadmin, writePUT/v2/databases/{databaseID}/access-list
listDatacentersreadGET/v2/databases/{databaseID}/datacenters
addDatacentersadmin, writePOST/v2/databases/{databaseID}/datacenters
initializeMigrationDCadmin, writePOST/v2/databases/{databaseID}/datacenters/{datacenterID}/migrations/initialize
terminateDatacenteradmin, deletePOST/v2/databases/{databaseID}/datacenters/{datacenterID}/terminate
updateEngineTypeadmin, writePUT/v2/databases/{databaseID}/engineType
removeKeyspaceadmin, deleteDELETE/v2/databases/{databaseID}/keyspaces/{keyspaceName}
addKeyspaceadmin, writePOST/v2/databases/{databaseID}/keyspaces/{keyspaceName}
alterKeyspaceWithGraphEngineadmin, writePOST/v2/databases/{databaseID}/keyspaces/{keyspaceName}/actions/alterWithGraphEngine
createSolrIndexadmin, writePOST/v2/databases/{databaseID}/keyspaces/{keyspaceName}/tables/{tableName}/solr/createCorewithconfigs
initializeMigrationadmin, writePOST/v2/databases/{databaseID}/migrations/initialize
getMigrationStatusreadGET/v2/databases/{databaseID}/migrations/{migrationID}
abortMigrationadmin, writePOST/v2/databases/{databaseID}/migrations/{migrationID}/abort
cleanupMigrationadmin, writePOST/v2/databases/{databaseID}/migrations/{migrationID}/cleanup
launchMigrationadmin, writePOST/v2/databases/{databaseID}/migrations/{migrationID}/launch
pauseMigrationadmin, writePOST/v2/databases/{databaseID}/migrations/{migrationID}/pause
resumeMigrationadmin, writePOST/v2/databases/{databaseID}/migrations/{migrationID}/resume
resetPasswordadmin, writePOST/v2/databases/{databaseID}/resetPassword
resizeDatabaseadmin, writePOST/v2/databases/{databaseID}/resize
generateSecureBundleURLadmin, readPOST/v2/databases/{databaseID}/secureBundleURL
listSnapshotsreadGET/v2/databases/{databaseID}/snapshots
getTelemetryConfigadmin, readGET/v2/databases/{databaseID}/telemetry/metrics
configureTelemetryadmin, writePOST/v2/databases/{databaseID}/telemetry/metrics
terminateDatabaseadmin, deletePOST/v2/databases/{databaseID}/terminate
cloneFromDBadmin, writePOST/v2/databases/{targetDBID}/cloneFrom/{sourceDBID}
cloneStatusreadGET/v2/databases/{targetDBID}/cloneStatus/{operationID}
generateReportadmin, writePOST/v2/enterprises/billing-reports/generate-report
getReportDetailsadmin, readGET/v2/enterprises/billing-reports/{reportId}
GetEnterpriseConsumptionadmin, readPOST/v2/enterprises/consumption
createOrganizationInEnterpriseadmin, writePOST/v2/enterprises/organizations
get:/v2/kmsadmin, readGET/v2/kms
post:/v2/kmsadmin, writePOST/v2/kms
ListClassicKeysadmin, readGET/v2/kms/classic
CreateClassicKeyadmin, writePOST/v2/kms/classic
AssignCloudAccountadmin, writePOST/v2/kms/classic/provider/{provider}/accounts
GetClassicKeyadmin, readGET/v2/kms/classic/provider/{provider}/region/{region}
GetClassicCloudAccountsadmin, readGET/v2/kms/classic/provider/{provider}/region/{region}/accounts
GetServerlessKeyadmin, readGET/v2/kms/provider/{provider}/region/{region}
GetServerlessCloudAccountsadmin, readGET/v2/kms/provider/{provider}/region/{region}/accounts
get:/v2/kms/serverlessadmin, readGET/v2/kms/serverless
post:/v2/kms/serverlessadmin, writePOST/v2/kms/serverless
RemoveAllowedPrincipalFromServiceadmin, deleteDELETE/v2/organizations/clusters/{clusterID}/datacenters/{datacenterID}/allowed-principals
AddAllowedPrincipaladmin, writePOST/v2/organizations/clusters/{clusterID}/datacenters/{datacenterID}/allowed-principals
AcceptEndpointToServiceadmin, writePOST/v2/organizations/clusters/{clusterID}/datacenters/{datacenterID}/endpoints
RejectEndpointadmin, deleteDELETE/v2/organizations/clusters/{clusterID}/datacenters/{datacenterID}/endpoints/{endpointID}
GetPrivateLinkEndpointadmin, readGET/v2/organizations/clusters/{clusterID}/datacenters/{datacenterID}/endpoints/{endpointID}
UpdateEndpointDescriptionadmin, writePUT/v2/organizations/clusters/{clusterID}/datacenters/{datacenterID}/endpoints/{endpointID}
GetPrivateLinksForDatacenteradmin, readGET/v2/organizations/clusters/{clusterID}/datacenters/{datacenterID}/private-link
AddAllowedPrincipalToServiceadmin, writePOST/v2/organizations/clusters/{clusterID}/datacenters/{datacenterID}/private-link
ListPrivateLinksForClusteradmin, readGET/v2/organizations/clusters/{clusterID}/private-link
getCustomDomainsadmin, readGET/v2/organizations/customDomains
setCustomDomainsadmin, writePOST/v2/organizations/customDomains
ListPrivateLinksForOrgadmin, readGET/v2/organizations/private-link
getOrganizationRolesadmin, readGET/v2/organizations/roles
addOrganizationRoleadmin, writePOST/v2/organizations/roles
deleteOrganizationRoleadmin, deleteDELETE/v2/organizations/roles/{roleID}
getOrganizationRoleadmin, readGET/v2/organizations/roles/{roleID}
updateRoleadmin, writePUT/v2/organizations/roles/{roleID}
getOrganizationUsersadmin, readGET/v2/organizations/users
inviteUserToOrganizationadmin, writePUT/v2/organizations/users
removeUserFromOrganizationadmin, deleteDELETE/v2/organizations/users/{userID}
getOrganizationUseradmin, readGET/v2/organizations/users/{userID}
UpdateRolesForUserInOrganizationadmin, writePUT/v2/organizations/users/{userID}/roles
deleteAuditLogExporterConfigadmin, deleteDELETE/v2/organizations/{orgID}/telemetry/auditLogs
getAuditLogExporterConfigadmin, readGET/v2/organizations/{orgID}/telemetry/auditLogs
setAuditLogExporterConfigadmin, writePOST/v2/organizations/{orgID}/telemetry/auditLogs
delete:/v2/organizations/{orgId}/devops-acladmin, deleteDELETE/v2/organizations/{orgId}/devops-acl
get:/v2/organizations/{orgId}/devops-acladmin, readGET/v2/organizations/{orgId}/devops-acl
patch:/v2/organizations/{orgId}/devops-acladmin, writePATCH/v2/organizations/{orgId}/devops-acl
post:/v2/organizations/{orgId}/devops-acladmin, writePOST/v2/organizations/{orgId}/devops-acl
put:/v2/organizations/{orgId}/devops-acladmin, writePUT/v2/organizations/{orgId}/devops-acl
pcuCreateadmin, writePOST/v2/pcus
pcuUpdateadmin, writePUT/v2/pcus
pcuGetreadPOST/v2/pcus/actions/get
pcuGroupGetByDatacenterUUIDreadGET/v2/pcus/actions/get/{datacenterUUID}
pcuAssociationTransferadmin, writePOST/v2/pcus/association/transfer
pcuAssociationGetreadGET/v2/pcus/association/{pcuGroupUUID}
pcuAssociationDeleteadmin, deleteDELETE/v2/pcus/association/{pcuGroupUUID}/{datacenterUUID}
pcuAssociationCreateadmin, writePOST/v2/pcus/association/{pcuGroupUUID}/{datacenterUUID}
pcuGroupParkadmin, writePOST/v2/pcus/park/{pcuGroupUUID}
pcuGetTypesreadPOST/v2/pcus/types
pcuGroupUnparkadmin, writePOST/v2/pcus/unpark/{pcuGroupUUID}
pcuDeleteadmin, deleteDELETE/v2/pcus/{pcuGroupUUID}
DeleteVPCPeeringConnectionadmin, deleteDELETE/v2/peering/provider/{provider}/database/{databaseID}
GetVPCPeeringConnectionDetailsadmin, readGET/v2/peering/provider/{provider}/database/{databaseID}
CreateVPCPeeringConnectionadmin, writePOST/v2/peering/provider/{provider}/database/{databaseID}
listServerlessRegionsreadGET/v2/regions/serverless
getSCIMResourceTypesadmin, readGET/v2/scim/ResourceTypes
getSCIMSchemasadmin, readGET/v2/scim/Schemas
getSCIMServiceProviderConfigadmin, readGET/v2/scim/ServiceProviderConfig
listSCIMGroupsadmin, readGET/v2/scim/groups
createSCIMGroupadmin, writePOST/v2/scim/groups
deleteSCIMGroupadmin, deleteDELETE/v2/scim/groups/{groupID}
getSCIMGroupadmin, readGET/v2/scim/groups/{groupID}
patchSCIMGroupadmin, writePATCH/v2/scim/groups/{groupID}
updateSCIMGroupadmin, writePUT/v2/scim/groups/{groupID}
listSCIMUsersadmin, readGET/v2/scim/users
createSCIMUseradmin, writePOST/v2/scim/users
deleteSCIMUseradmin, deleteDELETE/v2/scim/users/{userID}
getSCIMUseradmin, readGET/v2/scim/users/{userID}
patchSCIMUseradmin, writePATCH/v2/scim/users/{userID}
updateSCIMUseradmin, writePUT/v2/scim/users/{userID}
deleteTokenadmin, deleteDELETE/v2/tokens
getTokensForOrgadmin, readGET/v2/tokens
createTokenadmin, writePOST/v2/tokens
deleteCDCadmin, deleteDELETE/v3/databases/{databaseID}/cdc
getCDCreadGET/v3/databases/{databaseID}/cdc
enableCDCadmin, writePOST/v3/databases/{databaseID}/cdc
updateCDCadmin, writePUT/v3/databases/{databaseID}/cdc
getCDCStatusreadGET/v3/databases/{databaseID}/keyspaces/{keyspaceName}/tables/{tableName}/cdc

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.