DataStax Astra Developer Hub

Welcome to the DataStax Astra Developer Hub. You'll find comprehensive guides and documentation to help you start working with DataStax Astra as quickly as possible. Use the included APIs to create, modify, and terminate databases, and interact with the databases you create. Let's do it!

Astra Docs      API Reference      CQL for Astra

Authenticating your service account

Prerequisite

Create a Service Account to manage your organization.

Procedure

  1. Pass the clientName, clientId, and clientSecret from your service accountservice account - Allows you to manage your databases with the DevOps API, which can be used to create, terminate, resize, park, and unpark your database. The service account is created at the organization level. secret through the DevOps API.
curl --request POST \
  --url https://api.astra.datastax.com/v2/authenticateServiceAccount \
  --header 'accept: application/json' \
  --header 'content-type: application/json' \
  --data '{"clientName":"[email protected]","clientId":"58391caa-5c48-4e28-8b70-da3fe1624f3c","clientSecret":"42d9e2h3-4d25-40k8-aa1a-c9f6cc73ef10"}'

The DevOps API returns your authentication token, which is required for additional operations via the API:

qyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJsYmJUcDRObzdfUHBJLUxOWFZJbUFmY1pWQWs3TFNwdnY5Z0RFVF80M2ZrIn0.eyJqdGkiOiJmZDQ0ZmMzZC1iMzU2LTRhY2MtODI2Mi1kZjVjYjk0NTQxNzYiLCJleHAiOjE1OTU2MzYxODIsIm5iZiI6MCwiaWF0IjoxNTk1NjAwMTgyLCJpc3MiOiJodHRwczovL2F1dGguY2xvdWQuZGF0YXN0YXguY29tL2F1dGgvcmVhbG1zL0Nsb3VkVXNlcnMiLCJhdWQiOiI1ODM5MTlhYS01YzY6LTQ1MjgtOGIwMC1kYWYyZTE2MjRmY2MiLCJzdWIiOiJhZjZiOTZhNS04Yzk1LTRlNmItOTc2My0xODY5ZWVkM2E0MTUiLCJ0eXAiOiJJRCIsImF6cCI6IjU4MzkxOWFhLTVjNjgtNDUyOC04YjAwLWRhZjJlMTYyNGZjYyIsImF1dGhfdGltZSI6MCwic2Vzc2lvbl9zdGh0ZSI6ImU1YWE0YzM2LWZjMzQtNGZjYS1iZjAxLWY5MzdkNWIwMzkwNSIsImFjciI6IjEiLCJjbGllbnRIb3N0IjoiMTguMTg5LjI1Mi4xNTIiLCJvcmdFbWFpbCI6ImphbWllLmdpbGxlbndhdGVyQGRhdGFzdGF4LmNvbSIsImNsaWVudElkIjoiNTgzOTE5YWEtNWM2OC00NTI4LThiMDAtZGFmMmUxNjI0ZmNjIiwiZW1haWxDdmVyaWZpZWQiOmZhbHNlLCJvcmdOYW1lIjoiamFtaWUuZ2lsbGVud2F0ZXJAZGF0YXN0YXguY29tIiwicmVhbG1fYWNjZXNzIjp7InJvbGVzIjpbIm9mZmxpbmVfYWNjZXNzIiwidW1hX2F1dGhvcml6YXRpb24iLCIyMGRiYjQxOC0yN2ZiLTQ3MDgtOTBhZi1hYTFmZTM4NzM0ODkvU2VydmljZUFjY291bnQiXX0sIm9yZyI6IjIwZGJiNDE4LTI3ZmItNDcwOC05MGFmLWFhMWZlMzg3MzQ4OSIsInByZWZlcnJlZF91c2VybmFpZSI6InNlcnZpY2UtYWNjb3VudC01ODM5MTlhYS01YzY4LTQ1MjgtOGIwMC1kYWYyZTE2MjRmY2MiLCJjbGllbnRBZGRyZXNzIjoiMTguMTg5LjI1Mi4xNTIifQ.uif6hxHIDWh475rmQiCVr2MPfrRpg7JA272tnxLl7y0bBgngFdgJMZZRlB3oMZNgixSJutSc_7c8y-PDJ0DDJg3mXFMkFMgWzoXXpFXIp1zitdhlZ-SHMu2s6I1C2DJOCit6wPz8ZwrV8k4wGkfiqgwTyRBMQpK6Keaf7jkB7Uxi9M8vkJE2kE_vzuW-vmTZ4HeMZNAKxestccYUKH7WF1LZQNsYkl9vizxGlW6BORrBz_AmLxS8unZMDYNJFh8BAuCRRS9KOkyi6D4jZQRwX1xpN5erbiXmPR1JPM4pxAefuMlsbzlSF4R8sqkK0p_xzji5jSvGbjNqXckJmiSQeg
  1. Copy the authentication token, which is required to run additional commands in the DevOps API.

Updated 23 days ago



Authenticating your service account


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.