Skip to content

Latest commit

 

History

History
67 lines (39 loc) · 1.64 KB

api.md

File metadata and controls

67 lines (39 loc) · 1.64 KB
Raw

API Documentation

GET / [internal & external]

Returns a hardcoded string. This is useful to test connections and system health.

GET /v1/style [internal]

Return a descriptive string that cloudpipe can report to consumers of its API.

Response

The string "authstore" as plaintext.

GET /v1/validate?accountName={account}&apiKey={key} [internal]

Validate an API key against an account.

Response

  • 204 No Content: when the account name and API key are valid.
  • 404 Not Found: when the API key is not valid or the account does not exist.

POST /v1/accounts [external]

Create a new account.

Request

The Content-Type header must be application/x-www-form-urlencoded.

accountName={account}&password={password}

Response

  • 201 Created: Account created successfully.
  • 400 Bad Request: Malformed JSON or incomplete document.
  • 409 Conflict: Account name already taken.

POST /v1/keys [external]

Generate a new API key and associate it with your account.

Request

The Content-Type header must be application/x-www-form-urlencoded.

accountName={account}&password={password}

Response

  • 200 OK: Key generated successfully. Response body contains the generated API key as plaintext.
  • 401 Unauthorized: Unable to authenticate with the provided credentials.

DELETE /v1/keys?accountName={name}&apiKey={key} [external]

Revoke an API key from your account.

Response

  • 204 No Content: The API key has been successfully revoked.
  • 400 Bad Request: Request parameters are missing.
  • 401 Unauthorized: Unrecognized account or API key.