Cloud endpoint

Validate Cloud Credential

POST/cloud-credentials/validate/

Request body

application/json

See the request guidance below for a valid body.

cURL template

curl --fail-with-body \
  -H "Authorization: Bearer ${AKOFLOW_API_TOKEN}" \
  -H "Content-Type: application/json" \
  --data-binary @request.json \
  -X POST \
  "${AKOFLOW_API_URL}/cloud-credentials/validate/"

Supply a valid request.json before running this command.

200 OKapplication/json

Handler-checked response shape; values and optional fields vary.

{
  "valid": true,
  "provider": "gcp",
  "project": "project-id",
  "region": "region",
  "catalogStatus": "not_discovered"
}

Handler-checked behavior

Send provider, your actual provider credential JSON, and the project/region fields required by that provider. This route performs a live catalog discovery and does not save the credential. The current server registers only a GCP catalog adapter; AWS or Azure validation returns 422 as unsupported even though those credential records can be stored. No generic credential body can establish access; use the GCP guide for the current provider path.

Response shape

A 200 OK response verifies authentication and access to the Compute Engine project. It does not discover machines, images, disks, or prices. Save the environment and refresh its cloud catalog separately.

Related guide

See the Cloud guide for related tasks and context.