Refresh license entitlement

post https://{sandfly-api-host}/v4/license/refresh

Refresh an online license entitlement.

Responses

Response body

object

customer

object

required

string

Customer id.

string

required

Customer email.

name

string

required

Customer name.

website

string

required

Customer website.

date

object

required

expiry

string

required

License expiration date.

issued

string

required

License issue date.

warning

string

required

License warning date.

license_level

integer

required

License level.

1 4 8

limits

object

required

features

array of strings

required

features*

alerts

integer

required

Number of alerts allowed.

data_retention_max_hours

integer

required

Maximum number of hours of data retention.

email_notifications

integer

required

Number of email notifications allowed.

hosts

integer

required

Number of hosts allowed.

jump_hosts

integer

required

Number of jump hosts allowed.

named_queues

integer

required

Number of named queues allowed.

notifications

integer

required

Number of notification event configurations allowed.

schedules

integer

Number of schedules allowed.

syslog_notifications

integer

Number of syslog notifications allowed.

users

integer

required

Number of users allowed.

subscription

object

manage_url

uri

If present, a URL for the user to visit to manage this subscription or get additional information.

renewing

boolean

required

Indicates if this subscription is currently set to automatically renew at the end of the current term.

term_end

date-time

If present, the time the current subscription term ends. If the subscription is renewing, this is when the next subscription period will be billed; if not renewing, this is when the license will expire.

message

string

If present and non-empty, any messages that should be displayed to users about the status of the Sandfly subscription.

usage

object

required

alerts

integer

required

Number of alerts allowed.

data_retention_max_hours

integer

required

Maximum number of hours of data retention.

email_notifications

integer

required

Number of email notifications allowed.

hosts

integer

required

Number of hosts allowed.

jump_hosts

integer

required

Number of jump hosts allowed.

named_queues

integer

required

Number of named queues allowed.

notifications

integer

required

Number of notification event configurations allowed.

schedules

integer

Number of schedules allowed.

syslog_notifications

integer

Number of syslog notifications allowed.

users

integer

required

Number of users allowed.

version

integer

required

License version.

online

boolean

required

True is this is an online license entitlement.

online_warning

boolean

required

Indicates if there is a message in online_status that should be brought to the user's attention.

online_status

string

required

If an online license, a text status message describing the current state of the license. Will be an empty string if not an online license.

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://sandfly-api-host/v4/license/refresh \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200License refreshed

404License entry not found.

defaultUnexpected error