Skip to main content
POST
/
apps
/
{provider}
/
connect
Connect app with credentials
curl --request POST \
  --url https://api.onecli.sh/v1/apps/{provider}/connect \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "fields": {
    "apiKey": "sk-..."
  },
  "connectionId": "<string>",
  "label": "<string>",
  "method": "<string>"
}
'
{
  "success": true
}

Authorizations

​
Authorization
string
header
required

API key obtained from the dashboard or GET /user/api-key

Path Parameters

​
provider
string
required

App provider identifier (e.g., gmail, github, jira)

Body

application/json
​
fields
object
required

Credential fields required by the app

Example:
{ "apiKey": "sk-..." }
​
connectionId
string

Reconnect an existing connection

​
label
string

Display label for the connection. Defaults to a label derived from the credential metadata.

​
method
string

Connection method to use for apps with multiple methods (e.g. OAuth primary + API-key alternate). An unrecognized value is rejected.

Response

Connected

​
success
boolean