VoidhashDocs
DevelopersHelp centerGuidesAPI reference
Dashboard
Essentials
API overview
Authentication
Event capture
Push device API
Webhooks
Webhook delivery
Webhook events
Projects & keys
Projects
API keys
Audit log
Customers & access
Persons
Products
Perks
Sandbox
Paywalls
Paywalls
Paywall locations
Components
Component registry
Assets
Experiments & flags
Experiments
Feature flags
Analytics & events
Analytics
Analytics alerts
Events
Ingest policy
VoidQL
Tracking domains
Ads
Ads
Ad accounts
Meta measurement
Payments & stores
Payment providers
Payment provider products
Purchase history imports
Payment sources
Webhooks & notifications
Webhooks
Push notifications
Push configurations
Automations
Organization & team
Organizations
Members
Invitations
Billing
Your account
Profile
Session
Notices
Connected apps
Terms of Service
Developer tools
Schema
SDK
Retrieve the session
Sign out the CLI

Sign out the CLI

Signs the calling CLI out by deleting its own key, so a copy of the key left on the computer stops working.

Only a CLI key can sign itself out.

Guide: Verify a credential

DELETE
/api/v1/session

Authorization

AuthorizationBearer <token>

A project secret key: vh_sk_... for production, vh_sk_test_... for test. Keep it on your servers.

In: header

Examples

curl -X DELETE "https://api.voidhash.com/api/v1/session" \  -H "Authorization: Bearer vh_sk_..."
Empty
{  "error": {    "type": "invalid_request",    "code": "string",    "message": "string",    "param": "string"  }}
{  "error": {    "type": "unauthenticated",    "code": "invalid_api_key",    "message": "This secret key is not valid."  }}
{  "error": {    "type": "permission_denied",    "code": "cli_key_required",    "message": "Only a CLI key can sign itself out. Disconnect other apps from your connected apps."  }}
{  "error": {    "type": "internal",    "code": "internal_error",    "message": "Something went wrong on our side. Try again, and contact support with the Request-Id header if it keeps failing."  }}

Response body

application/json

application/json

application/json

application/json

Errors

StatustypecodeWhen
403permission_deniedcli_key_requiredFor any other credential.

It can also fail with the errors every operation shares, such as unauthenticated; see Errors.

More in Session

  • Retrieve the session GET

Something wrong or missing on this page? Tell us by email or on Discord.

PreviousRetrieve the sessionNextList notices

On this page

AuthorizationExamplesResponse bodyErrorsMore in Session