Skip to content
Core ConceptsCLI ReferenceAPI Reference
CompozyOS RuntimeAPI Reference

Extensions

Compozy Extensions HTTP endpoints.

Audience
Operators running durable agent work
Focus
API Reference guidance shaped for scanability, day-two clarity, and operator context.

List installed extensions

GET/api/extensions

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/api/extensions"
{  "extensions": [    {      "actions": [        "string"      ],      "bundles": [        {          "description": "string",          "name": "string",          "profiles": [            "string"          ]        }      ],      "capabilities": [        "string"      ],      "daemon_running": true,      "diagnostics": [        {          "category": "string",          "code": "string",          "data_freshness": "string",          "doc_url": "string",          "evidence": {            "property1": null,            "property2": null          },          "id": "string",          "message": "string",          "severity": "string",          "suggested_command": "string",          "title": "string"        }      ],      "enabled": true,      "health": "string",      "health_message": "string",      "last_error": "string",      "marketplace": {        "author": "string",        "description": "string",        "downloads": 0,        "entry_id": "string",        "install_slug": "string",        "installed": true,        "installed_name": "string",        "installed_version": "string",        "kind": "string",        "manage_path": "string",        "name": "string",        "published_at": "2019-08-24T14:15:22Z",        "source": "string",        "tier": "string",        "transport": "string",        "trust": {          "allow_unverified": true,          "checksum_verified": true,          "decision": "string",          "registry_tier": "string",          "warnings": [            {              "category": "string",              "code": "string",              "data_freshness": "string",              "doc_url": "string",              "evidence": {                "property1": null,                "property2": null              },              "id": "string",              "message": "string",              "severity": "string",              "suggested_command": "string",              "title": "string"            }          ]        },        "update_available": true,        "updated_at": "2019-08-24T14:15:22Z",        "version": "string"      },      "missing_env": [        "string"      ],      "name": "string",      "pid": 0,      "provenance": {        "allow_unverified": true,        "archive_digest_sha256": "string",        "catalog_entry_id": "string",        "checksum_sha256": "string",        "checksum_verified": true,        "installed_at": "2019-08-24T14:15:22Z",        "installed_by": "string",        "installed_from": "string",        "permissions": [          "string"        ],        "registry_tier": "string",        "slug": "string",        "source_url": "string",        "trust": {          "allow_unverified": true,          "checksum_verified": true,          "decision": "string",          "registry_tier": "string",          "warnings": [            {              "category": "string",              "code": "string",              "data_freshness": "string",              "doc_url": "string",              "evidence": {                "property1": null,                "property2": null              },              "id": "string",              "message": "string",              "severity": "string",              "suggested_command": "string",              "title": "string"            }          ]        },        "warnings": [          {            "category": "string",            "code": "string",            "data_freshness": "string",            "doc_url": "string",            "evidence": {              "property1": null,              "property2": null            },            "id": "string",            "message": "string",            "severity": "string",            "suggested_command": "string",            "title": "string"          }        ]      },      "requires_env": [        "string"      ],      "source": "string",      "state": "string",      "trust": {        "allow_unverified": true,        "checksum_verified": true,        "decision": "string",        "registry_tier": "string",        "warnings": [          {            "category": "string",            "code": "string",            "data_freshness": "string",            "doc_url": "string",            "evidence": {              "property1": null,              "property2": null            },            "id": "string",            "message": "string",            "severity": "string",            "suggested_command": "string",            "title": "string"          }        ]      },      "type": "string",      "uptime_seconds": 0,      "version": "string"    }  ]}

Install a local or marketplace extension

POST/api/extensions

Request Body

application/json

JSON request body

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/extensions" \  -H "Content-Type: application/json" \  -d '{}'
{  "extension": {    "actions": [      "string"    ],    "bundles": [      {        "description": "string",        "name": "string",        "profiles": [          "string"        ]      }    ],    "capabilities": [      "string"    ],    "daemon_running": true,    "diagnostics": [      {        "category": "string",        "code": "string",        "data_freshness": "string",        "doc_url": "string",        "evidence": {          "property1": null,          "property2": null        },        "id": "string",        "message": "string",        "severity": "string",        "suggested_command": "string",        "title": "string"      }    ],    "enabled": true,    "health": "string",    "health_message": "string",    "last_error": "string",    "marketplace": {      "author": "string",      "description": "string",      "downloads": 0,      "entry_id": "string",      "install_slug": "string",      "installed": true,      "installed_name": "string",      "installed_version": "string",      "kind": "string",      "manage_path": "string",      "name": "string",      "published_at": "2019-08-24T14:15:22Z",      "source": "string",      "tier": "string",      "transport": "string",      "trust": {        "allow_unverified": true,        "checksum_verified": true,        "decision": "string",        "registry_tier": "string",        "warnings": [          {            "category": "string",            "code": "string",            "data_freshness": "string",            "doc_url": "string",            "evidence": {              "property1": null,              "property2": null            },            "id": "string",            "message": "string",            "severity": "string",            "suggested_command": "string",            "title": "string"          }        ]      },      "update_available": true,      "updated_at": "2019-08-24T14:15:22Z",      "version": "string"    },    "missing_env": [      "string"    ],    "name": "string",    "pid": 0,    "provenance": {      "allow_unverified": true,      "archive_digest_sha256": "string",      "catalog_entry_id": "string",      "checksum_sha256": "string",      "checksum_verified": true,      "installed_at": "2019-08-24T14:15:22Z",      "installed_by": "string",      "installed_from": "string",      "permissions": [        "string"      ],      "registry_tier": "string",      "slug": "string",      "source_url": "string",      "trust": {        "allow_unverified": true,        "checksum_verified": true,        "decision": "string",        "registry_tier": "string",        "warnings": [          {            "category": "string",            "code": "string",            "data_freshness": "string",            "doc_url": "string",            "evidence": {              "property1": null,              "property2": null            },            "id": "string",            "message": "string",            "severity": "string",            "suggested_command": "string",            "title": "string"          }        ]      },      "warnings": [        {          "category": "string",          "code": "string",          "data_freshness": "string",          "doc_url": "string",          "evidence": {            "property1": null,            "property2": null          },          "id": "string",          "message": "string",          "severity": "string",          "suggested_command": "string",          "title": "string"        }      ]    },    "requires_env": [      "string"    ],    "source": "string",    "state": "string",    "trust": {      "allow_unverified": true,      "checksum_verified": true,      "decision": "string",      "registry_tier": "string",      "warnings": [        {          "category": "string",          "code": "string",          "data_freshness": "string",          "doc_url": "string",          "evidence": {            "property1": null,            "property2": null          },          "id": "string",          "message": "string",          "severity": "string",          "suggested_command": "string",          "title": "string"        }      ]    },    "type": "string",    "uptime_seconds": 0,    "version": "string"  }}

Get one installed extension

GET/api/extensions/{name}

Path Parameters

name*string

Extension name

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/extensions/string"
{  "extension": {    "actions": [      "string"    ],    "bundles": [      {        "description": "string",        "name": "string",        "profiles": [          "string"        ]      }    ],    "capabilities": [      "string"    ],    "daemon_running": true,    "diagnostics": [      {        "category": "string",        "code": "string",        "data_freshness": "string",        "doc_url": "string",        "evidence": {          "property1": null,          "property2": null        },        "id": "string",        "message": "string",        "severity": "string",        "suggested_command": "string",        "title": "string"      }    ],    "enabled": true,    "health": "string",    "health_message": "string",    "last_error": "string",    "marketplace": {      "author": "string",      "description": "string",      "downloads": 0,      "entry_id": "string",      "install_slug": "string",      "installed": true,      "installed_name": "string",      "installed_version": "string",      "kind": "string",      "manage_path": "string",      "name": "string",      "published_at": "2019-08-24T14:15:22Z",      "source": "string",      "tier": "string",      "transport": "string",      "trust": {        "allow_unverified": true,        "checksum_verified": true,        "decision": "string",        "registry_tier": "string",        "warnings": [          {            "category": "string",            "code": "string",            "data_freshness": "string",            "doc_url": "string",            "evidence": {              "property1": null,              "property2": null            },            "id": "string",            "message": "string",            "severity": "string",            "suggested_command": "string",            "title": "string"          }        ]      },      "update_available": true,      "updated_at": "2019-08-24T14:15:22Z",      "version": "string"    },    "missing_env": [      "string"    ],    "name": "string",    "pid": 0,    "provenance": {      "allow_unverified": true,      "archive_digest_sha256": "string",      "catalog_entry_id": "string",      "checksum_sha256": "string",      "checksum_verified": true,      "installed_at": "2019-08-24T14:15:22Z",      "installed_by": "string",      "installed_from": "string",      "permissions": [        "string"      ],      "registry_tier": "string",      "slug": "string",      "source_url": "string",      "trust": {        "allow_unverified": true,        "checksum_verified": true,        "decision": "string",        "registry_tier": "string",        "warnings": [          {            "category": "string",            "code": "string",            "data_freshness": "string",            "doc_url": "string",            "evidence": {              "property1": null,              "property2": null            },            "id": "string",            "message": "string",            "severity": "string",            "suggested_command": "string",            "title": "string"          }        ]      },      "warnings": [        {          "category": "string",          "code": "string",          "data_freshness": "string",          "doc_url": "string",          "evidence": {            "property1": null,            "property2": null          },          "id": "string",          "message": "string",          "severity": "string",          "suggested_command": "string",          "title": "string"        }      ]    },    "requires_env": [      "string"    ],    "source": "string",    "state": "string",    "trust": {      "allow_unverified": true,      "checksum_verified": true,      "decision": "string",      "registry_tier": "string",      "warnings": [        {          "category": "string",          "code": "string",          "data_freshness": "string",          "doc_url": "string",          "evidence": {            "property1": null,            "property2": null          },          "id": "string",          "message": "string",          "severity": "string",          "suggested_command": "string",          "title": "string"        }      ]    },    "type": "string",    "uptime_seconds": 0,    "version": "string"  }}

Remove one managed extension

DELETE/api/extensions/{name}

Path Parameters

name*string

Extension name

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/api/extensions/string"
{  "extension": {    "name": "string",    "path": "string",    "status": "string",    "warnings": [      {        "category": "string",        "code": "string",        "data_freshness": "string",        "doc_url": "string",        "evidence": {          "property1": null,          "property2": null        },        "id": "string",        "message": "string",        "severity": "string",        "suggested_command": "string",        "title": "string"      }    ]  }}

Update one marketplace-installed extension

PUT/api/extensions/{name}

Path Parameters

name*string

Extension name

Request Body

application/json

JSON request body

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PUT "https://example.com/api/extensions/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "update": {    "current_version": "string",    "latest_version": "string",    "name": "string",    "path": "string",    "registry": "string",    "slug": "string",    "status": "string",    "warnings": [      {        "category": "string",        "code": "string",        "data_freshness": "string",        "doc_url": "string",        "evidence": {          "property1": null,          "property2": null        },        "id": "string",        "message": "string",        "severity": "string",        "suggested_command": "string",        "title": "string"      }    ]  }}

Disable an installed extension

POST/api/extensions/{name}/disable

Path Parameters

name*string

Extension name

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/extensions/string/disable"
{  "extension": {    "actions": [      "string"    ],    "bundles": [      {        "description": "string",        "name": "string",        "profiles": [          "string"        ]      }    ],    "capabilities": [      "string"    ],    "daemon_running": true,    "diagnostics": [      {        "category": "string",        "code": "string",        "data_freshness": "string",        "doc_url": "string",        "evidence": {          "property1": null,          "property2": null        },        "id": "string",        "message": "string",        "severity": "string",        "suggested_command": "string",        "title": "string"      }    ],    "enabled": true,    "health": "string",    "health_message": "string",    "last_error": "string",    "marketplace": {      "author": "string",      "description": "string",      "downloads": 0,      "entry_id": "string",      "install_slug": "string",      "installed": true,      "installed_name": "string",      "installed_version": "string",      "kind": "string",      "manage_path": "string",      "name": "string",      "published_at": "2019-08-24T14:15:22Z",      "source": "string",      "tier": "string",      "transport": "string",      "trust": {        "allow_unverified": true,        "checksum_verified": true,        "decision": "string",        "registry_tier": "string",        "warnings": [          {            "category": "string",            "code": "string",            "data_freshness": "string",            "doc_url": "string",            "evidence": {              "property1": null,              "property2": null            },            "id": "string",            "message": "string",            "severity": "string",            "suggested_command": "string",            "title": "string"          }        ]      },      "update_available": true,      "updated_at": "2019-08-24T14:15:22Z",      "version": "string"    },    "missing_env": [      "string"    ],    "name": "string",    "pid": 0,    "provenance": {      "allow_unverified": true,      "archive_digest_sha256": "string",      "catalog_entry_id": "string",      "checksum_sha256": "string",      "checksum_verified": true,      "installed_at": "2019-08-24T14:15:22Z",      "installed_by": "string",      "installed_from": "string",      "permissions": [        "string"      ],      "registry_tier": "string",      "slug": "string",      "source_url": "string",      "trust": {        "allow_unverified": true,        "checksum_verified": true,        "decision": "string",        "registry_tier": "string",        "warnings": [          {            "category": "string",            "code": "string",            "data_freshness": "string",            "doc_url": "string",            "evidence": {              "property1": null,              "property2": null            },            "id": "string",            "message": "string",            "severity": "string",            "suggested_command": "string",            "title": "string"          }        ]      },      "warnings": [        {          "category": "string",          "code": "string",          "data_freshness": "string",          "doc_url": "string",          "evidence": {            "property1": null,            "property2": null          },          "id": "string",          "message": "string",          "severity": "string",          "suggested_command": "string",          "title": "string"        }      ]    },    "requires_env": [      "string"    ],    "source": "string",    "state": "string",    "trust": {      "allow_unverified": true,      "checksum_verified": true,      "decision": "string",      "registry_tier": "string",      "warnings": [        {          "category": "string",          "code": "string",          "data_freshness": "string",          "doc_url": "string",          "evidence": {            "property1": null,            "property2": null          },          "id": "string",          "message": "string",          "severity": "string",          "suggested_command": "string",          "title": "string"        }      ]    },    "type": "string",    "uptime_seconds": 0,    "version": "string"  }}

Enable an installed extension

POST/api/extensions/{name}/enable

Path Parameters

name*string

Extension name

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/extensions/string/enable"
{  "extension": {    "actions": [      "string"    ],    "bundles": [      {        "description": "string",        "name": "string",        "profiles": [          "string"        ]      }    ],    "capabilities": [      "string"    ],    "daemon_running": true,    "diagnostics": [      {        "category": "string",        "code": "string",        "data_freshness": "string",        "doc_url": "string",        "evidence": {          "property1": null,          "property2": null        },        "id": "string",        "message": "string",        "severity": "string",        "suggested_command": "string",        "title": "string"      }    ],    "enabled": true,    "health": "string",    "health_message": "string",    "last_error": "string",    "marketplace": {      "author": "string",      "description": "string",      "downloads": 0,      "entry_id": "string",      "install_slug": "string",      "installed": true,      "installed_name": "string",      "installed_version": "string",      "kind": "string",      "manage_path": "string",      "name": "string",      "published_at": "2019-08-24T14:15:22Z",      "source": "string",      "tier": "string",      "transport": "string",      "trust": {        "allow_unverified": true,        "checksum_verified": true,        "decision": "string",        "registry_tier": "string",        "warnings": [          {            "category": "string",            "code": "string",            "data_freshness": "string",            "doc_url": "string",            "evidence": {              "property1": null,              "property2": null            },            "id": "string",            "message": "string",            "severity": "string",            "suggested_command": "string",            "title": "string"          }        ]      },      "update_available": true,      "updated_at": "2019-08-24T14:15:22Z",      "version": "string"    },    "missing_env": [      "string"    ],    "name": "string",    "pid": 0,    "provenance": {      "allow_unverified": true,      "archive_digest_sha256": "string",      "catalog_entry_id": "string",      "checksum_sha256": "string",      "checksum_verified": true,      "installed_at": "2019-08-24T14:15:22Z",      "installed_by": "string",      "installed_from": "string",      "permissions": [        "string"      ],      "registry_tier": "string",      "slug": "string",      "source_url": "string",      "trust": {        "allow_unverified": true,        "checksum_verified": true,        "decision": "string",        "registry_tier": "string",        "warnings": [          {            "category": "string",            "code": "string",            "data_freshness": "string",            "doc_url": "string",            "evidence": {              "property1": null,              "property2": null            },            "id": "string",            "message": "string",            "severity": "string",            "suggested_command": "string",            "title": "string"          }        ]      },      "warnings": [        {          "category": "string",          "code": "string",          "data_freshness": "string",          "doc_url": "string",          "evidence": {            "property1": null,            "property2": null          },          "id": "string",          "message": "string",          "severity": "string",          "suggested_command": "string",          "title": "string"        }      ]    },    "requires_env": [      "string"    ],    "source": "string",    "state": "string",    "trust": {      "allow_unverified": true,      "checksum_verified": true,      "decision": "string",      "registry_tier": "string",      "warnings": [        {          "category": "string",          "code": "string",          "data_freshness": "string",          "doc_url": "string",          "evidence": {            "property1": null,            "property2": null          },          "id": "string",          "message": "string",          "severity": "string",          "suggested_command": "string",          "title": "string"        }      ]    },    "type": "string",    "uptime_seconds": 0,    "version": "string"  }}

Get extension provenance and trust evidence

GET/api/extensions/{name}/provenance

Path Parameters

name*string

Extension name

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/extensions/string/provenance"
{  "provenance": {    "allow_unverified": true,    "archive_digest_sha256": "string",    "catalog_entry_id": "string",    "checksum_sha256": "string",    "checksum_verified": true,    "installed_at": "2019-08-24T14:15:22Z",    "installed_by": "string",    "installed_from": "string",    "permissions": [      "string"    ],    "registry_tier": "string",    "slug": "string",    "source_url": "string",    "trust": {      "allow_unverified": true,      "checksum_verified": true,      "decision": "string",      "registry_tier": "string",      "warnings": [        {          "category": "string",          "code": "string",          "data_freshness": "string",          "doc_url": "string",          "evidence": {            "property1": null,            "property2": null          },          "id": "string",          "message": "string",          "severity": "string",          "suggested_command": "string",          "title": "string"        }      ]    },    "warnings": [      {        "category": "string",        "code": "string",        "data_freshness": "string",        "doc_url": "string",        "evidence": {          "property1": null,          "property2": null        },        "id": "string",        "message": "string",        "severity": "string",        "suggested_command": "string",        "title": "string"      }    ]  }}

Providers

Compozy Providers HTTP endpoints.

Vault

Compozy Vault HTTP endpoints.