API reference · Credentials

Delete credentials

DELETE /v1/credentials/{platform}

Delete BYO credentials for a platform

Request

Authenticate with a bearer API key. Agents calling over MCP authorise with OAuth instead and never handle the key.

curl -X DELETE https://api.postlake.dev/v1/credentials/{platform} \
  -H "Authorization: Bearer $POSTLAKE_API_KEY"

Parameters

FieldTypeRequiredWhat it is
platformstringYesIn the URL.

Response

Deleted (204).

Limits

Write operations are limited per account, and every response carries X-RateLimit-Remaining and X-RateLimit-Reset. A 429 includes Retry-After. Send an Idempotency-Key so a retry after a timeout cannot duplicate the work.

Calling this from an agent

This operation is part of the REST surface. Agents working over the hosted MCP server reach the same product through tools instead, and authorise with OAuth so your API key is never pasted into a chat. See the MCP server.

Errors

Every failure uses one shape: a stable type, a granular code, the field at fault in param, and a plain-language fix. An agent can act on it without a person reading the message. See Errors and retries.

Retries are safe. Send the same Idempotency-Key and a call that already succeeded returns its original result rather than repeating it.

Common questions

Is it safe to retry this call?

Yes. Send the same Idempotency-Key and a call that already succeeded returns its original result instead of repeating the work. That is what makes it safe to hand to an agent that retries on its own.

What happens when it fails?

You get one error shape: a stable type, a granular code you can branch on, the offending field in param, and a fix written so an agent can correct itself rather than stop. Full list on Errors and retries.

Related