Extensions API
Beta
Steel stores the Chrome extensions that your organization uploads, and a session installs one when you pass its ID in extensionIds. These endpoints upload, list, download, update and delete extensions. For the base URL and authentication, see API conventions. For the error codes, see Errors.
The first example is a complete program that uploads extension.zip from the current folder. The later examples use its client, and the ID of an extension in EXTENSION_ID (cURL), extensionId (TypeScript), extension_id (Python and Rust) or extensionID (Go).
Endpoints
Upload an extension
POST/v1/extensions
Uploads a Chrome extension from a .zip or .crx file, or from its Chrome Web Store URL. The request is multipart/form-data. Send file or url.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
file | file · body | No | The extension, as a . or . file. |
url | string (uri) · body | No | The Chrome Web Store URL of the extension. |
The response is 201:
Response
| Field | Type | Description |
|---|---|---|
id | string | The Chrome extension ID: 32 letters from a to p, such as mjoedlfflcchnleknnceiplgaeoegien. |
name | string | The name of the extension. |
createdAt | string | When the extension was uploaded. |
updatedAt | string | When the extension last changed. |
See Extensions.
curl -X POST https://api.steel.dev/v1/extensions \
-H "steel-api-key: $STEEL_API_KEY" \
-F "file=@extension.zip"import { createReadStream } from "node:fs";
import Steel from "steel-sdk";
const client = new Steel();
const extension = await client.extensions.upload({
file: createReadStream("extension.zip"),
});
console.log(extension.id);from pathlib import Path
from steel import Steel
client = Steel()
extension = client.extensions.upload(file=Path("extension.zip"))
print(extension.id)package main
import (
"context"
"fmt"
"io"
"log"
"os"
"github.com/steel-dev/sdk/go"
)
func main() {
if err := run(context.Background()); err != nil {
log.Fatal(err)
}
}
func run(ctx context.Context) error {
client := steel.NewClient()
file, err := os.Open("extension.zip")
if err != nil {
return err
}
defer file.Close()
extension, err := client.Extensions.Upload(ctx, steel.ExtensionUploadParams{
File: steel.F[io.Reader](file),
})
if err != nil {
return err
}
fmt.Println(extension.ID)
return nil
}#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
let client = steel_rs::Client::new();
let file = steel_rs::Upload::open("extension.zip").await?;
let extension = client
.extensions()
.upload(steel_rs::ExtensionUploadParams {
file: Some(file),
..Default::default()
})
.await?;
println!("{}", extension.id);
Ok(())
}List extensions
GET/v1/extensions
Lists your organization's extensions.
This endpoint takes no parameters.
Response
| Field | Type | Description |
|---|---|---|
extensions | object[] | The extensions, each with id, name, createdAt and updatedAt. |
count | number | The total number of extensions. |
See Extensions.
curl https://api.steel.dev/v1/extensions \
-H "steel-api-key: $STEEL_API_KEY"const { extensions } = await client.extensions.list();
for (const extension of extensions) {
console.log(extension.id, extension.name);
}result = client.extensions.list()
for extension in result.extensions:
print(extension.id, extension.name)result, err := client.Extensions.List(ctx)
if err != nil {
return err
}
for _, extension := range result.Extensions {
fmt.Println(extension.ID, extension.Name)
}let result = client.extensions().list().await?;
for extension in result.extensions {
println!("{} {}", extension.id, extension.name);
}Download an extension
GET/v1/extensions/{extensionId}
Downloads one extension.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
extensionId | string · path | Yes | The ID of the extension. |
The response is the extension as a ZIP file, application/zip.
See Extensions.
curl https://api.steel.dev/v1/extensions/$EXTENSION_ID \
-H "steel-api-key: $STEEL_API_KEY" \
-o extension.zipimport { writeFile } from "node:fs/promises";
const archive = await client.extensions.download(extensionId);
await writeFile("extension.zip", Buffer.from(await archive.arrayBuffer()));archive = client.extensions.download(extension_id)
archive.write_to_file("extension.zip")import (
"io"
"os"
)
archive, err := client.Extensions.Download(ctx, extensionID)
if err != nil {
return err
}
defer archive.Body.Close()
body, err := io.ReadAll(archive.Body)
if err != nil {
return err
}
if err := os.WriteFile("extension.zip", body, 0o644); err != nil {
return err
}let archive = client.extensions().download(&extension_id).await?;
std::fs::write("extension.zip", archive)?;Update an extension
PUT/v1/extensions/{extensionId}
Replaces an extension with a new .zip or .crx file, or with a Chrome Web Store URL. The request is multipart/form-data. Send file or url.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
extensionId | string · path | Yes | The ID of the extension. |
file | file · body | No | The new extension, as a . or . file. |
url | string (uri) · body | No | The Chrome Web Store URL of the extension. |
The response has the fields in Upload an extension.
See Extensions.
curl -X PUT https://api.steel.dev/v1/extensions/$EXTENSION_ID \
-H "steel-api-key: $STEEL_API_KEY" \
-F "file=@extension.zip"import { createReadStream } from "node:fs";
const extension = await client.extensions.update(extensionId, {
file: createReadStream("extension.zip"),
});
console.log(extension.updatedAt);from pathlib import Path
extension = client.extensions.update(extension_id, file=Path("extension.zip"))
print(extension.updated_at)import (
"io"
"os"
)
file, err := os.Open("extension.zip")
if err != nil {
return err
}
defer file.Close()
extension, err := client.Extensions.Update(ctx, extensionID, steel.ExtensionUpdateParams{
File: steel.F[io.Reader](file),
})
if err != nil {
return err
}
fmt.Println(extension.UpdatedAt)let file = steel_rs::Upload::open("extension.zip").await?;
let extension = client
.extensions()
.update(
&extension_id,
steel_rs::ExtensionUpdateParams {
file: Some(file),
..Default::default()
},
)
.await?;
println!("{}", extension.updated_at);Delete an extension
DELETE/v1/extensions/{extensionId}
Deletes one extension.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
extensionId | string · path | Yes | The ID of the extension. |
Response
| Field | Type | Description |
|---|---|---|
message | string | A message about the result. |
See Extensions.
curl -X DELETE https://api.steel.dev/v1/extensions/$EXTENSION_ID \
-H "steel-api-key: $STEEL_API_KEY"await client.extensions.delete(extensionId);client.extensions.delete(extension_id)if _, err := client.Extensions.Delete(ctx, extensionID); err != nil {
return err
}client.extensions().delete(&extension_id).await?;Delete all extensions
DELETE/v1/extensions
Deletes every extension of your organization.
This endpoint takes no parameters.
Response
| Field | Type | Description |
|---|---|---|
message | string | A message about the result. |
See Extensions.
curl -X DELETE https://api.steel.dev/v1/extensions \
-H "steel-api-key: $STEEL_API_KEY"const result = await client.extensions.deleteAll();
console.log(result.message);result = client.extensions.delete_all()
print(result.message)result, err := client.Extensions.DeleteAll(ctx)
if err != nil {
return err
}
fmt.Println(result.Message)let result = client.extensions().delete_all().await?;
println!("{}", result.message);