Actions142
- Access Token Actions
- Blueprint Actions
- Client Actions
- Domain Actions
- Identity Provider Actions
- Create an OpenID Connect identity provider.
- Update an OpenID Connect identity provider.
- Delete an identity provider.
- Get an identity provider.
- List identity providers.
- Attach an identity provider to an organization.
- Detach an identity provider from an organization.
- Update an identity provider’s configuration for an organization.
- List organizations attached to an identity provider.
- Organization Actions
- Get a site by orgId and niceId. NiceId is a readable ID for the site and unique on a per org basis.
- Create a new site.
- List sites.
- Get default values for new sites.
- Get an organization.
- Delete an organization.
- Update an organization.
- Create a role.
- List roles.
- Create a new organization.
- List organizations.
- Check that a user belongs to an organization and has the specified role.
- Get a resource by its niceId.
- Create a new resource.
- List resources.
- List domains.
- Remove a user from an organization.
- Get a user in an organization.
- Update a user’s role in an organization.
- List users.
- Create an invite for a user to join an organization.
- List invitations.
- Add a user to an organization.
- Create a client.
- List clients.
- Create a resource for a site.
- Delete a resource.
- Get a resource.
- Update a resource.
- List all site resources.
- List access tokens.
- List blueprints.
- Create a blueprint.
- Get a blueprint.
- Delete an API key.
- List API key actions.
- Perform an action on an API key.
- List API keys.
- Create an API key.
- List request logs.
- Get default values for creating a client.
- Get a domain.
- Update a domain.
- List DNS records for a domain.
- Attach an identity provider to an organization.
- Detach an identity provider from an organization.
- Update an identity provider’s configuration for an organization.
- List organizations attached to an identity provider.
- Resource Actions
- Create a target.
- List targets that point to this resource.
- Grant roles access to a resource, replacing any existing ones.
- List roles that have access to a resource.
- Get a resource by its niceId.
- Create a new resource.
- List resources.
- Create a resource for a site.
- Delete a resource.
- Get a resource.
- Update a resource.
- List all site resources.
- Grant users access to a resource, replacing any existing ones.
- List users that have access to a resource.
- Set the password for a resource.
- Set the pincode for a resource.
- Set the whitelist for a resource.
- Get the whitelist for a resource.
- Apply a rule to a resource.
- Remove a rule from a resource.
- Update a rule applied to a resource.
- List rules applied to a resource.
- Set header auth for a resource.
- Add entries to the whitelist for a resource.
- Remove entries from the whitelist for a resource.
- Create an access token for a resource.
- List access tokens for a resource.
- Role Actions
- Rule Actions
- Site Actions
- Get a site by orgId and niceId. NiceId is a readable ID for the site and unique on a per org basis.
- Get a site by siteId.
- Delete a site.
- Update a site.
- Create a new site.
- List sites.
- Get default values for new sites.
- Create a resource for a site.
- Delete a resource.
- Get a resource.
- Update a resource.
- Get a resource by its niceId.
- List resources.
- List all site resources.
- Target Actions
- User Actions
- Check that a user belongs to an organization and has the specified role.
- Remove a user from an organization.
- Get a user in an organization.
- Update a user’s role in an organization.
- List users.
- Add a user to an organization.
- Grant users access to a resource, replacing any existing ones.
- List users that have access to a resource.
- Assign a role to a user.
- Get a user.
- Enable 2FA for a user.
Site → Get a site by siteId.
AI-generatedSummary
Retrieve detailed information about a specific site by providing its unique site ID.
Inputs
- Site ID (required) — The unique identifier of the site to retrieve.
- Options — Optional settings for the request, including whether to return the raw full response instead of parsed items.
Output shape
a single JSON object representing the site data, or the full raw response if the Raw Response option is enabled
The output is a single record JSON object; if Raw Response is enabled, the entire response data is returned as-is without splitting arrays into individual items.
Examples
Example 1: Retrieve site information for site ID '12345'
Set 'Site ID' to '12345' and leave 'Raw Response' option off to receive the parsed site data object.