Functions
Stop a Function Instance
Stops a Function instance. This method immediately halts the running function.
post/v2.0/functions/{functionId}/instances/{functionInstanceId}/stop
Request
- Base URLhttps://api-trial.cognigy.ai/testing
- Auth
- API key in header X-API-Key
- or API key in query parameter api_key
- or API key in header x-cxone-authorization
- or OAuth 2Authorization code/auth/oauth2/authorizePasswordToken URL/auth/oauth2/token
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
functionIdstring required
The Id of the Function
functionInstanceIdstring required
The Id of the Function Instance
Headers
Accept'application/json' | 'application/hal+json' | 'application/xml' | 'text/xml' | 'text/csv'
The Accept header specifies the media type that the client expects in the response. Available options: application/json, application/hal+json, application/xml, text/xml, text/csv. The default value is application/json.
Response
The stop operation was accepted.
Changes
No recorded changes to this operation across all 1 revision of this API.