SDK Apps > RPCs

List App RPCs

get
/sdk/apps/{SDK_appName}/{SDK_appVersion}/rpcs
Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
SDK_appNamestringRequired
SDK_appVersionstringRequired
Responses
200

Successful response

application/json
get
/sdk/apps/{SDK_appName}/{SDK_appVersion}/rpcs
200

Successful response

Create RPC

post
/sdk/apps/{SDK_appName}/{SDK_appVersion}/rpcs
Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
SDK_appNamestringRequired
SDK_appVersionstringRequired
Body
namestringOptional
labelstringOptional
connectionstring | nullableOptional
Responses
200

Successful response

application/json
post
/sdk/apps/{SDK_appName}/{SDK_appVersion}/rpcs
200

Successful response

Get RPC

get
/sdk/apps/{SDK_appName}/{SDK_appVersion}/rpcs/{SDK_rpcName}
Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
SDK_appNamestringRequired
SDK_appVersionstringRequired
SDK_rpcNamestringRequired
Responses
200

Successful response

application/json
get
/sdk/apps/{SDK_appName}/{SDK_appVersion}/rpcs/{SDK_rpcName}
200

Successful response

Test RPC

post
/sdk/apps/{SDK_appName}/{SDK_appVersion}/rpcs/{SDK_rpcName}

Tests the RPC

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
SDK_appNamestringRequired
SDK_appVersionstringRequired
SDK_rpcNamestringRequired
Body
Responses
200

Successful response

No content

post
/sdk/apps/{SDK_appName}/{SDK_appVersion}/rpcs/{SDK_rpcName}
200

Successful response

No content

Delete RPC

delete
/sdk/apps/{SDK_appName}/{SDK_appVersion}/rpcs/{SDK_rpcName}
Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
SDK_appNamestringRequired
SDK_appVersionstringRequired
SDK_rpcNamestringRequired
Responses
200

Successful response

application/json
delete
/sdk/apps/{SDK_appName}/{SDK_appVersion}/rpcs/{SDK_rpcName}
200

Successful response

Patch RPC

patch
/sdk/apps/{SDK_appName}/{SDK_appVersion}/rpcs/{SDK_rpcName}
Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
SDK_appNamestringRequired
SDK_appVersionstringRequired
SDK_rpcNamestringRequired
Body
labelstringOptional
connectionstring | nullableOptional
altConnectionstring | nullableOptional
Responses
200

Successful response

application/json
patch
/sdk/apps/{SDK_appName}/{SDK_appVersion}/rpcs/{SDK_rpcName}
200

Successful response

Get RPC Section

get
/sdk/apps/{SDK_appName}/{SDK_appVersion}/rpcs/{SDK_rpcName}/{SDK_rpcSection}
Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
SDK_appNamestringRequired
SDK_appVersionstringRequired
SDK_rpcNamestringRequired
SDK_rpcSectionstring · enumRequiredPossible values:
Responses
200

Successful response

application/json
get
/sdk/apps/{SDK_appName}/{SDK_appVersion}/rpcs/{SDK_rpcName}/{SDK_rpcSection}
200

Successful response

Set RPC Section

put
/sdk/apps/{SDK_appName}/{SDK_appVersion}/rpcs/{SDK_rpcName}/{SDK_rpcSection}

Available sections: api, parameters

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
SDK_appNamestringRequired
SDK_appVersionstringRequired
SDK_rpcNamestringRequired
SDK_rpcSectionstring · enumRequiredPossible values:
Body
urlstringOptional
methodstringOptional
qsobjectOptional
bodyobjectOptional
headersobjectOptional
Responses
200

Successful response

application/json
put
/sdk/apps/{SDK_appName}/{SDK_appVersion}/rpcs/{SDK_rpcName}/{SDK_rpcSection}
200

Successful response

Last updated