API
API
API
Device.lastConnectedAt is deprecated
Aug 18, 2023
Device.lastConnectedAt
This field is now deprecated and will return an empty value.
Device.lastConnectedAt is deprecated
Aug 18, 2023
Device.lastConnectedAt
This field is now deprecated and will return an empty value.
Security Policies on Resources support
Aug 9, 2023
Added support for Security Policies on Resources.
resourceCreate
and resourceUpdate
Added the ability to specify the Resource's security policy.
groupCreate
Providing a Security Policy will now set the Security Policy used to access any Groups also passed during creation.
groupUpdate
Providing a Security Policy will update the Security Policy used to access all of the Resources the Group has access to, including Resources not passed in
addedResourceIds
. No Security Policies will be updated if no Security Policy is passed.
(New) resourceAccessAdd
Given a Resource, add Groups or Service Accounts with access to the Resource and, for Groups, define which Security Policy they use.
(New) resourceAccessSet
Given a Resource, set which Groups or Service Accounts have access to the Resource and, for Groups, which Security Policy they use. Groups and Service Accounts not included in this call will be removed.
(New) resourceAccessRemove
Given a Resource, remove Groups' and Security Accounts' access to the Resource.
Security Policies on Resources support
Aug 9, 2023
Added support for Security Policies on Resources.
resourceCreate
and resourceUpdate
Added the ability to specify the Resource's security policy.
groupCreate
Providing a Security Policy will now set the Security Policy used to access any Groups also passed during creation.
groupUpdate
Providing a Security Policy will update the Security Policy used to access all of the Resources the Group has access to, including Resources not passed in
addedResourceIds
. No Security Policies will be updated if no Security Policy is passed.
(New) resourceAccessAdd
Given a Resource, add Groups or Service Accounts with access to the Resource and, for Groups, define which Security Policy they use.
(New) resourceAccessSet
Given a Resource, set which Groups or Service Accounts have access to the Resource and, for Groups, which Security Policy they use. Groups and Service Accounts not included in this call will be removed.
(New) resourceAccessRemove
Given a Resource, remove Groups' and Security Accounts' access to the Resource.
User support
Apr 6, 2023
Added expanded support for managing users.
(New) userCreate
Creates and optionally invites a new user. If you use an IdP, contact us to enable adding users via social login.
(New) userDelete
Deletes a user. Users who are synced via an IdP cannot be deleted.
(New) userRoleUpdate
Updates a user's role.
(New) userDetailsUpdate
Updates details about a user.
User support
Apr 6, 2023
Added expanded support for managing users.
(New) userCreate
Creates and optionally invites a new user. If you use an IdP, contact us to enable adding users via social login.
(New) userDelete
Deletes a user. Users who are synced via an IdP cannot be deleted.
(New) userRoleUpdate
Updates a user's role.
(New) userDetailsUpdate
Updates details about a user.
Resource alias support
Apr 5, 2023
Added the ability to assign aliases to Resources.
resourceCreate
and resourceUpdate
A Resource's alias can be now be set from the API.
Resource
The
alias
field is the Resource's alias, if one is set.
Resource alias support
Apr 5, 2023
Added the ability to assign aliases to Resources.
resourceCreate
and resourceUpdate
A Resource's alias can be now be set from the API.
Resource
The
alias
field is the Resource's alias, if one is set.
IdP and social login support
Apr 4, 2023
Added the ability to see whether a user is synced from your account's IdP or manually added.
users
Added the ability to query users by their type.
User
Added the
type
field, denoting whether a user is synced or manually added.
IdP and social login support
Apr 4, 2023
Added the ability to see whether a user is synced from your account's IdP or manually added.
users
Added the ability to query users by their type.
User
Added the
type
field, denoting whether a user is synced or manually added.
Connector state filters
Feb 13, 2023
Added the ability to filter Connectors by their state.
connectors
Connectors can now be filtered by their state.
Connector state filters
Feb 13, 2023
Added the ability to filter Connectors by their state.
connectors
Connectors can now be filtered by their state.
Device state support
Jan 3, 2023
Added the ability to query and mutate Device state.
(New) deviceArchive
Archives a Device. Devices are unarchived when they next connect to Twingate.
(New) deviceBlock
Blocks a Device. Blocked Devices cannot access Twingate.
(New) deviceUnblock
Unblocks a Device.
devices
Devices can now be filtered by device state.
Device
Devices now have an
activeState
field, which determines whether the Device is active, archived, or blocked.
Device state support
Jan 3, 2023
Added the ability to query and mutate Device state.
(New) deviceArchive
Archives a Device. Devices are unarchived when they next connect to Twingate.
(New) deviceBlock
Blocks a Device. Blocked Devices cannot access Twingate.
(New) deviceUnblock
Unblocks a Device.
devices
Devices can now be filtered by device state.
Device
Devices now have an
activeState
field, which determines whether the Device is active, archived, or blocked.
Resource visibilty support
Dec 22, 2022
Added API support for Resource Visibility.
resourceCreate
and resourceUpdate
Added the ability to set and update a Resource's visibility options.
Resource
Added two fields for a Resource's visibility options:
isVisible
: whether a Resource will be in the main Resource list in the Client.isBrowserShortcutEnabled
: whether a Resource will have an "Open in Browser" shortcut in the Client.
Resource visibilty support
Dec 22, 2022
Added API support for Resource Visibility.
resourceCreate
and resourceUpdate
Added the ability to set and update a Resource's visibility options.
Resource
Added two fields for a Resource's visibility options:
isVisible
: whether a Resource will be in the main Resource list in the Client.isBrowserShortcutEnabled
: whether a Resource will have an "Open in Browser" shortcut in the Client.
Set Remote Network location
Dec 8, 2022
Added the ability to specify a Remote Network's location.
remoteNetworkCreate
Added the ability to set
location
during creation time. The location will default to "other" if not set.
remoteNetworkUpdate
Added the ability to update
location
.
(New) RemoteNetworkLocation
An enum of possible Remote Network locations, one of AWS, Azure, Google Cloud, on premises or other.
RemoteNetwork
Now has a
location
field specifying where the Remote Network is located
Set Remote Network location
Dec 8, 2022
Added the ability to specify a Remote Network's location.
remoteNetworkCreate
Added the ability to set
location
during creation time. The location will default to "other" if not set.
remoteNetworkUpdate
Added the ability to update
location
.
(New) RemoteNetworkLocation
An enum of possible Remote Network locations, one of AWS, Azure, Google Cloud, on premises or other.
RemoteNetwork
Now has a
location
field specifying where the Remote Network is located
Toggle Connector downtime notifications
Sep 13, 2022
Added the ability to toggle whether a Connector should have downtime notifications from the API.
connectorCreate
and connectorUpdate
Status notifications can be toggled on and off for a Connector by setting
hasStatusNotificationsEnabled
true or false respectively.
Toggle Connector downtime notifications
Sep 13, 2022
Added the ability to toggle whether a Connector should have downtime notifications from the API.
connectorCreate
and connectorUpdate
Status notifications can be toggled on and off for a Connector by setting
hasStatusNotificationsEnabled
true or false respectively.
Security Policy on Groups
Aug 4, 2022
Added the ability to set a Group's Security Policy.
securityPolicyCreate
and securityPolicyUpdate
Added the ability to specify
securityPolicyID
to set a Group's Security Policy.
Security Policy on Groups
Aug 4, 2022
Added the ability to set a Group's Security Policy.
securityPolicyCreate
and securityPolicyUpdate
Added the ability to specify
securityPolicyID
to set a Group's Security Policy.
Name Connectors at creation time
Jul 6, 2022
Added the ability to name Connectors at creation time.
connectorCreate
Now takes a
name
argument that will set the Connector's name.
Name Connectors at creation time
Jul 6, 2022
Added the ability to name Connectors at creation time.
connectorCreate
Now takes a
name
argument that will set the Connector's name.
Service Account support
Apr 9, 2022
Added API endpoints to manage Service Accounts.
(New) serviceAccountKey
Looks up and returns a
ServiceAccountKey
by its ID.
(New) serviceAccount
Looks up and returns a
ServiceAccount
by its ID.
(New) serviceAccountKeyCreate
Creates a new Service Key for a Service Account.
(New) serviceAccountKeyUpdate
Renames a Service Key.
(New) serviceAccountKeyRevoke
Revokes a Service Key. Any headless clients using this Service Key will no longer be able to connect to Twingate.
(New) serviceAccountKeyDelete
Deletes a Service Key. Any headless clients using this Service Key will no longer be able to connect to Twingate.
(New) serviceAccountCreate
Creates a new Service Account, optionally with a list of Resources that the Service Account will have access to.
(New) serviceAccountUpdate
Updates an existing Service Account, including renaming the Service Account or adding and removing Resources from the Service Account.
(New) serviceAccountDelete
Deletes a Service Account.
(New) ServiceAccountKey
An object containing information about a Service Key, including its status and expiration time.
(New) ServiceAccount
An object containing information about a Service Account, including its associated Resources and Service Keys.
Service Account support
Apr 9, 2022
Added API endpoints to manage Service Accounts.
(New) serviceAccountKey
Looks up and returns a
ServiceAccountKey
by its ID.
(New) serviceAccount
Looks up and returns a
ServiceAccount
by its ID.
(New) serviceAccountKeyCreate
Creates a new Service Key for a Service Account.
(New) serviceAccountKeyUpdate
Renames a Service Key.
(New) serviceAccountKeyRevoke
Revokes a Service Key. Any headless clients using this Service Key will no longer be able to connect to Twingate.
(New) serviceAccountKeyDelete
Deletes a Service Key. Any headless clients using this Service Key will no longer be able to connect to Twingate.
(New) serviceAccountCreate
Creates a new Service Account, optionally with a list of Resources that the Service Account will have access to.
(New) serviceAccountUpdate
Updates an existing Service Account, including renaming the Service Account or adding and removing Resources from the Service Account.
(New) serviceAccountDelete
Deletes a Service Account.
(New) ServiceAccountKey
An object containing information about a Service Key, including its status and expiration time.
(New) ServiceAccount
An object containing information about a Service Account, including its associated Resources and Service Keys.
Resources must be deleted before Remote Networks
Dec 1, 2021
Deleting a Remote Network will now fail if the Remote Network has any Resources.
remoteNetworkDelete
If a Remote Network has any Resources,
remoteNetworkDelete
will fail and return an error. Delete all of a Remote Network's Resources before deleting the Remote Network.
Resources must be deleted before Remote Networks
Dec 1, 2021
Deleting a Remote Network will now fail if the Remote Network has any Resources.
remoteNetworkDelete
If a Remote Network has any Resources,
remoteNetworkDelete
will fail and return an error. Delete all of a Remote Network's Resources before deleting the Remote Network.
Device support
Sep 15, 2021
Added the ability to query and mutate Devices from the API.
(New) device
Looks up and returns a
Device
by its ID.
(New) devices
Looks up and returns a zero or more
Device
s that match the filter criteria.
(New) deviceUpdate
Mutates a Device's state, currently only used for manually verifying a device.
(New) Device
An object containing information about a Device, including information about verification status, its hardware and its user.
Device support
Sep 15, 2021
Added the ability to query and mutate Devices from the API.
(New) device
Looks up and returns a
Device
by its ID.
(New) devices
Looks up and returns a zero or more
Device
s that match the filter criteria.
(New) deviceUpdate
Mutates a Device's state, currently only used for manually verifying a device.
(New) Device
An object containing information about a Device, including information about verification status, its hardware and its user.
Connector renaming
Aug 25, 2021
Added the ability to rename Connectors from the API.
(New) connectorUpdate
The
connectorUpdate
endpoint is able to rename a Connector.
Connector renaming
Aug 25, 2021
Added the ability to rename Connectors from the API.
(New) connectorUpdate
The
connectorUpdate
endpoint is able to rename a Connector.
Filter Groups, Remote Networks, and Resources by name
Jul 19, 2021
You can now filter Groups, Remote Networks, and Resources by their names.
groups
, remoteNetworks
, and resources
For each query, the
filter
parameter now has aname
field to filter objects by their name.
Filter Groups, Remote Networks, and Resources by name
Jul 19, 2021
You can now filter Groups, Remote Networks, and Resources by their names.
groups
, remoteNetworks
, and resources
For each query, the
filter
parameter now has aname
field to filter objects by their name.
Unique Connector names
Jun 15, 2021
Connector names are now unique within a Remote Network rather than with an entire account.
connectorCreate
and connectorUpdate
Connector names are now unique within a Remote Network rather than within an entire account.
Unique Connector names
Jun 15, 2021
Connector names are now unique within a Remote Network rather than with an entire account.
connectorCreate
and connectorUpdate
Connector names are now unique within a Remote Network rather than within an entire account.
You've reached the end
Head to our docs for instructions on Getting Started with the API.
If you use Infrastructure-as-Code, take a look at our Terraform Provider.