circle-info
Read on newly released AI assisted Insights
flxbl docsarrow-up-right
search
Learn CD Concepts using LabsslackGitHub

Integrations

hashtag
List all integrations

get

List all configured integrations. Returns integration metadata without credentials.

Authentication: Requires Owner role. This endpoint is for administrative purposes to view and manage integrations.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
providerstring · enumOptional

Filter by provider: github or jira

Possible values:
Responses
chevron-right
200

List of integrations

No content
get
/sfp/api/integrations
No content

hashtag
Store credentials for external services (Jira, GitHub)

post

Securely store credentials for external integrations. Credentials are encrypted at rest using AES-256.

Authentication: Requires user authentication (Owner or Member role). Application tokens are not permitted for credential creation.

Scope options:

  • Global (isGlobal: true): Credentials available to all projects. Use for shared services like a company-wide Jira.

  • Project-scoped (projects: [...]): Credentials only for specific repositories. Projects must be registered first via POST /projects.

Common setups:

  • Jira: provider: "jira", authType: "basic_auth", credentials: { base_url, username, api_token }

  • GitHub PAT: provider: "github", authType: "pat", credentials: { token }

See full guide: https://docs.flxbl.io/sfp/api-reference/integrations

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
providerstring · enumRequired

External service to integrate with

Default: githubPossible values:
authTypestring · enumRequired

How to authenticate with the provider. Use pat for GitHub tokens, basic_auth for Jira (email + API token), app for GitHub App, or oauth for OAuth flows.

Default: patPossible values:
credentialsobjectRequired

Provider-specific credentials. For GitHub PAT: { token: "ghp_xxx" }. For Jira basic_auth: { base_url: "https://company.atlassian.net", username: "email", api_token: "token" }.

Example: {"token":"ghp_xxxx"}
projectsstring[]Optional

Repository identifiers to scope this integration to. Get these from GET /projects or register via POST /projects. Required if isGlobal is false.

Example: ["flxbl-io/sf-core","acme-corp/salesforce-main"]
isGlobalbooleanOptional

Set true to make credentials available to ALL projects. Use for shared services like a company-wide Jira instance. Either isGlobal or projects must be specified.

Example: true
configobjectOptional

Provider-specific configuration options

Responses
post
/sfp/api/integrations
No content

hashtag
Retrieve stored credentials

get

Fetch decrypted credentials for integrations. Returns credentials matching the filter criteria. All access is logged for audit purposes.

Authentication: Accepts both user authentication and application tokens. Machine access is logged as app:<token_id> for audit trail.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
providerstring · enumOptional

Filter by service: github or jira

Possible values:
projectstringOptional

Filter by registered project identifier (e.g., flxbl-io/sf-core). List projects via GET /projects.

Responses
chevron-right
200

Credentials retrieved successfully

No content
get
/sfp/api/integrations/credentials
No content

hashtag
Delete an integration

delete

Permanently delete an integration and its encrypted credentials.

Authentication: Requires Owner role. This action cannot be undone.

Effects:

  • Removes the integration configuration

  • Deletes encrypted credentials from secure storage

  • Removes integration reference from associated projects

  • Logs deletion in audit trail

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired

Integration ID (UUID)

Responses
delete
/sfp/api/integrations/{id}
No content

Last updated