Skip to content

Disconnect GitHub

DELETE
/stores/{storeRef}/integrations/github
curl --request DELETE \
--url https://apibase.ecomweb.app/api/v1/stores/example/integrations/github \
--header 'x-api-key: <x-api-key>'

Disconnects the store’s GitHub app installation. It does not delete the repository, which stays on GitHub, but EcomWeb stops updating it. Connecting GitHub again starts from the dashboard. Needs the admin:store scope.

Required scopes: admin:store

storeRef
required
string

The store’s ref, as returned by GET /stores.

GitHub is disconnected.

The key is missing, invalid, revoked or expired.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}

The key may not do this: a missing scope, a readonly key, a publishable key on a Store API route, or a disallowed origin.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}