Fivetran documentation

Search the docs

/

License Interface

Fetch licenses

GET/api/v6.1/licenses

Query parameters	Prototype: `'license' ?: ( + )`
Request headers	None
Request body	None
Response headers	None
Response body (JSON)	Prototype: `license : { 'status' : 'NONE' \| 'VALID' \| 'EXPIRED' \| 'HOST_MISMATCH' \| 'EXCEEDED' \| 'INVALID' 'props' ?: { prop : value } }`
Status codes	✅ 200 OK ❌ 400 Bad Request
Required permissions	No special permission required Available while Setup Mode is active.

Add a new license

POST/api/v6.1/licenses

Query parameters	None
Request headers	None
Request body (JSON)	Prototype: `'license' : 'raw' :`
Response headers	None
Response body	None
Status codes	✅ 201 Created ❌ 400 Bad Request
Required permissions	SysAdmin access level Available while Setup Mode is active.
Events	Creates the following event License_Add `'license' :`

Delete a license

DELETE/api/v6.1/licenses/{license}

Query parameters	None
Request headers	None
Request body	None
Response headers	None
Response body	None
Status codes	✅ 201 Created ❌ 400 Bad Request ❌ 404 Not Found: License not found
Required permissions	SysAdmin access level Available while Setup Mode is active.
Events	Creates the following event License_Delete `'license' :`

Fetch raw content of a license

GET/api/v6.1/licenses/{license}

Query parameters	None
Request headers	None
Request body	None
Response headers	None
Response body (text)	None
Status codes	✅ 200 OK ❌ 400 Bad Request ❌ 404 Not Found: License not found
Required permissions	SysAdmin access level Available while Setup Mode is active.

(re)create a new license

PUT/api/v6.1/licenses/{license}

Query parameters	None
Request headers	None
Request body (JSON)	Prototype: `'raw' :`
Response headers	None
Response body	None
Status codes	✅ 201 Created ❌ 400 Bad Request
Required permissions	SysAdmin access level Available while Setup Mode is active.
Events	Creates one or more of the following events License_Add `'license' :` License_Replace `'license' :`

Show licensing status

GET/api/v6.1/licensing

Query parameters	None
Request headers	None
Request body	None
Response headers	None
Response body (JSON)	Prototype: `'status' : 'NONE' \| 'VALID' \| 'EXPIRED' \| 'HOST_MISMATCH' \| 'EXCEEDED' \| 'INVALID' 'licensing_expiry_warning' ?: 'capture_restrict' ?: ( { 'classes' ?: ( + ) 'max_locs' ?: }* ) 'integrate_restrict' ?: ( { 'classes' ?: ( + ) 'max_locs' ?: }* ) 'extra_features' ?: { 'sap_unpack' ?: { 'max_locs' ?: } }`
Status codes	✅ 200 OK ❌ 400 Bad Request
Required permissions	No special permission required

Set Hub Server property License_Agreement_Accepted

POST/api/v6.1/licensing/license_agreement_accepted

Query parameters	None
Request headers	None
Request body	None
Response headers	None
Response body	None
Status codes	✅ 200 OK ❌ 400 Bad Request
Required permissions	No special permission required
Events	Creates no events.

Thanks for your feedback!

Was this page helpful?