Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Managing connectors

Use the recommended skill to create, review, update, promote, and delete bring your own connector definitions.

Use this page to create, list, update, promote, and delete custom connectors in Scalekit.

Create connectors in Dev first, validate the definition, and then use the same definition for updates or Production rollout.

Use it to:

  • Infer the connector auth type
  • Generate the connector payload
  • Review existing connectors before create or update
  • Show diffs before updates
  • Move connector definitions from Dev to Production
  • Prepare the delete curl for a connector

Whenever the skill shows you the final connector payload, review the values carefully before approving or running the next step.

If you prefer to manage custom connectors with the APIs directly, use the curl commands on this page and the JSON bodies from Auth patterns.

Before using the curl examples on this page, make sure:

  • SCALEKIT_ENVIRONMENT_URL points to the Scalekit environment where you want to manage the connector
  • env_access_token contains a valid environment access token for that environment; obtain one by posting your client_id and client_secret to $SCALEKIT_ENVIRONMENT_URL/oauth/token with grant_type=client_credentials

Create a connector

Section titled “Create a connector”

Create the connector in Dev first. Share the connector name, Scalekit credentials, API docs, auth docs, and base API URL if you already know it. The skill will infer the auth pattern, generate the connector payload, and help you create it.

Use one of the JSON payloads from Auth patterns as the request body:

Terminal window
curl --location "$SCALEKIT_ENVIRONMENT_URL/api/v1/custom-providers" \
  --header "Authorization: Bearer $env_access_token" \
  --header "Content-Type: application/json" \
  --data '{...}'

After the connector is created, create a connection in the Scalekit Dashboard and continue with the standard connector flow.

List connectors

Section titled “List connectors”

List existing connectors before you create or update one. This helps you confirm whether the connector already exists and whether you should create a new connector or update an existing one.

Terminal window
curl --location "$SCALEKIT_ENVIRONMENT_URL/api/v1/providers?filter.provider_type=CUSTOM&page_size=1000" \
  --header "Authorization: Bearer $env_access_token"

Update a connector

Section titled “Update a connector”

When a connector changes, use the skill to compare the current connector with the proposed payload. Review auth fields, scopes, and proxy settings carefully before applying the update, because these values affect how future authorization and proxy calls behave.

Use the List connectors API to get the connector identifier from the response before sending the update request.

Use the updated JSON body from Auth patterns and the connector identifier in the update request:

Terminal window
curl --location --request PUT "$SCALEKIT_ENVIRONMENT_URL/api/v1/custom-providers/$PROVIDER_IDENTIFIER" \
  --header "Authorization: Bearer $env_access_token" \
  --header "Content-Type: application/json" \
  --data '{...}'

Move a connector from Dev to Production

Section titled “Move a connector from Dev to Production”

Use the Dev connector as the source of truth. The skill can locate the matching connector in Dev, compare it with Production, and prepare the correct action from there.

In practice, this means:

  • fetch the connector definition from Dev
  • review the payload
  • create it in Production if it does not exist
  • update it in Production if it already exists

Use the same JSON body from Auth patterns for the Production create or update request. This keeps the connector definition consistent between environments.

Delete a connector

Section titled “Delete a connector”

To delete a connector, resolve the correct connector identifier first. If the connector is still in use, remove the related connections or connected accounts before retrying the delete flow.

Use the List connectors API to get the connector identifier from the response before sending the delete request.

Terminal window
curl --location --request DELETE "$SCALEKIT_ENVIRONMENT_URL/api/v1/custom-providers/$PROVIDER_IDENTIFIER" \
  --header "Authorization: Bearer $env_access_token"