API Keys

syntropynet.syntropy.syntropy_api_key

Allows the creation/deletion of endpoint agent API Keys.

Parameter Choices/Defaults Comments
api_token
string
API Authorization token string.
This parameter is required if SYNTROPY_API_TOKEN environment variable is not set.
api_url
string
URL Of the Platform API.
This parameter is required if SYNTROPY_API_SERVER environment variable is not set.
expires
string
ISO formatted API key expiration datetime.
If expires is null, then current day-time + 30 days will be used as expiration date.
name
string / required
API Key name.
state
string
    Choices:
  • present ←
  • absent
A desired state of the API key.
suspend
boolean
    Choices:
  • no ←
  • yes
Indicate whether the API Key is suspended.


Did this page help you?