Skip to main content

Publish an extension

Request

Available on Free, Pro, and Enterprise plans

Publish a new Foxglove extension or an updated version of an existing extension. When uploaded, the extension will automatically be installed for users in your organization.

See our packaging tool create-foxglove-extension for more information on how to create an extension.

Read the docs for more information on Foxglove extensions.

Security
ApiKey(Required scopes: extensions.create)
Bodyapplication/octet-streamrequired

The request headers must contain Content-Type: application/octet-stream. The request body must contain the contents of your (.foxe) extension file. All other information about the extension will be parsed from the package.json file.

package.json requirements

An extension is uniquely identified by its publisher and name, which are both required in your package.json. Both values are case-insensitive, so a package named custompanel would be the same as one named CustomPanel.

To update an extension, change its version in package.json, create a new .foxe bundle, and upload it via this endpoint. Version numbers must be unique to each extension. There are no other restrictions on versioning schemes.

To publish an extension to your organization, your package.json must define a displayName. This is displayed to users in your organization.

Once an extension is uploaded, its displayName may not be changed by future versions.

string, (binary)
Payload
string

Responses

Extension ID

Bodyapplication/json
idstringrequired
Response
{ "id": "string" }