Skip to content

API tokens (api-bridge.clever-cloud.com)

Source: src/Resource/Bridge/ApiTokensResource.php

CRUD over Personal API tokens. Lives on the api-bridge gateway, not the regular API host.

Access

$client->apiTokens

Authentication requirement

This resource requires OAuth 1.0a authentication. The gateway validates the header shape and rejects Bearer tokens with HTTP 400 and the message headers/authorization Invalid input: must start with "OAuth ". This is the point of these endpoints: you sign with your OAuth 1.0a consumer credentials in order to mint a Bearer token. So a client authenticated with an API token CANNOT manage API tokens.

The SDK does not check upfront - the API will respond 400 if you call it with the wrong credentials.

Methods

public function list(): list<ApiToken>
public function get(string $tokenId): ApiToken
public function create(array $payload): ApiToken
public function update(string $tokenId, array $payload): ApiToken
public function delete(string $tokenId): void
Method HTTP Path Body
list() GET https://api-bridge.clever-cloud.com/api-tokens -
get() GET .../api-tokens/{id} -
create() POST .../api-tokens {"name": "...", "scopes": ["..."]?, "expires_at": "..."?}
update() PATCH .../api-tokens/{id} {"name"?: "...", "scopes"?: [...]}
delete() DELETE .../api-tokens/{id} -

The SDK builds these URLs by: 1. Using ApiVersion::Bridge (which AbstractBridgeResource::version() pins). 2. Configuration::baseUrlFor(Bridge) returning bridgeBaseUrl (default https://api-bridge.clever-cloud.com). 3. The resource itself writing the full /api-tokens path - there's no implicit /v1 or /v2 prefix on the Bridge base URL.

ApiToken DTO

Fields (verified against src/Model/ApiToken.php):

public string  $id;
public string  $name;
public ?string $token;        // ⚠ Only populated on creation responses - store it immediately
public array   $scopes;       // list<string>
public ?string $createdAt;
public ?string $expiresAt;
public ?string $lastUsedAt;
public ?string $ipAddress;

Creating a token

$token = $client->apiTokens->create([
    'name'       => 'CI deploys',
    'scopes'     => ['application:read', 'application:write'],
    'expires_at' => '2027-01-01T00:00:00Z', // optional
]);

// IMPORTANT: $token->token is the plaintext value. It's only returned ONCE.
// Subsequent list() / get() calls will leave it null.
echo "Save this token: ".$token->token;

See also