Skip to navigation

Get CLI publish status

Whether the install host serves this cli surface, and the commands that install it. Read live from the install host’s bucket.

Authentication

AuthorizationBearer
API key or Clerk session token

Path parameters

productIdstringRequired
surfaceIdstringRequired

Response

Publish status
installobject
installDomainobject

The custom install domain the surface asks for and whether it is verified; null when it asks for none

publishedAtstring or null
When the files last changed
slugstring or null

The install slug, which is the surface’s command name; null while it has none

stateenum

published: the install host serves this surface’s files under its slug. not_published: nothing is published, the surface has no valid command name, or another surface holds the slug.

Allowed values:
versionstring or null

The version in the published cli.json

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error
502
Bad Gateway Error
503
Service Unavailable Error