API Reference
Start typing to search…

Update an Event Subscription

put
https://{server}/ns-api/v2/subscriptions/
Path Params
string
required
Body Params
string
enum

This is the type of data that will be sent. you will need to reqest multiple subscriptions if you want more than one model. Addtional details available in guide at https://developer.onecloud.us/docs/event-subscriptions-1

url

This is the url the API will be posting data to. Should be in the format including https://. Can make a custom port if needed and the URL should have a valid SSL certificate as well. Http:// is supproted but not ideal for production.

string
enum
Defaults to yes

This allows any added configurations to specify a hostname. Default to "yes"

Allowed:
date-time

This timestamp in the format of YYYY-MM-DD HH:MM:SS will be with the subscription will expire. After it expires it will be removed after some amount of time. If left blank it will set the expires time to the expires time of the timed token used, if using a APIkey it will be 20 years from the creation date that it will set for the expires for the new subscription

string

This is the server hostname for the prefered server for this subscription, meaning if this server is up and online it will be the one sending the events. It wil fail back to this servre after 60s of stability.

integer

This is the number of attempted post's that resulted in a error, either an inability to send to a server (network,dns, timeout, etc..) or a response code that is above a 302. This value can be "reset" by setting it to 0 in a update request, but only 0 is allowed value.

integer

This is the number of attempted post's in this schedule. This includes error and success attempts. This value can be "reset" by setting it to 0 in a update request, but only 0 is allowed value.

Responses

Updated 11 months ago

Language
Credentials
Bearer
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 11 months ago