Services Administration lets administrators create and manage services. Services are reusable configurations for connecting Unqork modules to external systems, like APIs, FTP servers, or custom authentication providers. Once created, a service can be referenced by any module with access to it.
Important: Managing services requires administrative permissions. Administrators needing access should contact their environment administrator.
Service List
The service list displays all services configured in the environment.
| Column | Description |
|---|---|
| Service | The display name of the service. Select the name to open the service detail view. |
| Description | A description of the service. Set in the service detail view after creation. |
| Auth Type | The authentication type configured for the service. |
| Actions | Service-level actions. |
Actions
| Action | Description |
|---|---|
| Add a Service | Opens a modal to create a new service. |
| Open | Opens the service detail view. Available from the Manage drop-down on any row. |
| Delete | Permanently removes the service. Available from the Manage drop-down on any row. This action cannot be undone. |
Adding a Service
Click Add a Service to open a modal with the following steps: Create Service and Manage Access.
Create Service
| Field | Description |
|---|---|
| Service Title | The display name for the service. |
| Service Name | A unique identifier for the service. Must contain only letters, numbers, and hyphens. Cannot be changed after creation. |
| Service Protocol + Host | The base URL or host to which the service connects. |
| Allow service execution from in server-side execution only | When set to ON, this setting restricts the service to server-side execution only. |
Click Next to proceed to Manage Access.
Manage Access
Configure which workspaces can use this service.
| Option | Description |
|---|---|
| Environment | The service is available to all workspaces in the environment. |
| Workspaces | The service is available only to selected workspaces. |
| ↳ Select workspaces to share this service with | Select one or more workspaces to grant access to this service. Visible when Workspaces is selected. |
Click Create to save the service. After creation, the service detail view opens automatically.
Service Detail
The service detail view is organized into the following sections, accessible from the sidebar navigation: Service Info, Manage Access, Service Type, Request & Response, and Logging.
Click Edit to make the form editable. Click Save Changes to save, or Cancel to discard changes.
Service Info
| Field | Description |
|---|---|
| Service Title | The display name for the service. Editable. |
| Service Name | The unique identifier. Read-only after creation. |
| Description | An optional description of the service. |
| Allow service execution from in server-side execution only | When set to ON, this setting restricts the service to server-side execution. |
Manage Access
Controls which workspaces can use this service.
| Option | Description |
|---|---|
| Environment | The service is available to all workspaces in the environment. |
| Workspaces | The service is available only to selected workspaces. |
| ↳ Select workspaces to share this service with | Select one or more workspaces to grant access to this service. Visible when Workspaces is selected. |
Service Type
Configures how the service connects to an external system. Select a Service Type to reveal its configuration fields.
Authentication
| Field | Description |
|---|---|
| Service Protocol + Host | The base URL or host for the service. |
| Authentication Method | The authentication approach. Options include: Standard or Custom. |
| ↳ Authentication Type | The specific authentication protocol. For the full list of types and their configuration fields, see Service Types. Visible when Authentication Method is Standard. |
| ↳ Authenticators | The custom authenticator to use. Visible when Authentication Method is Custom. |
Mutual TLS
Available for most authentication types. Enables mutual TLS authentication between Unqork and the external service.
| Setting | Description |
|---|---|
| Enable Mutual TLS | When set to ON, this setting enables mutual TLS for the service connection. |
| ↳ Certificate | The client certificate to use for mutual TLS authentication. Visible when Enable Mutual TLS is ON. |
| ↳ Do not follow redirect | When checked, this setting prevents the service from following HTTP redirects. Visible when Enable Mutual TLS is ON. |
SOAP Digital Signature
Available for services using no authentication, WSSE Username Token, or Custom SOAP Header authentication.
| Setting | Description |
|---|---|
| Enable SOAP Digital Signature | When set to ON, this setting enables digital signing of SOAP requests. |
| ↳ PFX/PKCS12 key | The PFX or PKCS12 certificate file used to sign SOAP requests. Visible when Enable SOAP Digital Signature is ON. |
| ↳ PFX Passphrase | The passphrase for the PFX certificate. Visible when Enable SOAP Digital Signature is ON. |
| ↳ Signing Algorithm | The algorithm used to sign the SOAP message. Visible when Enable SOAP Digital Signature is ON. |
| ↳ Digest Algorithm | The algorithm used to compute the message digest. Visible when Enable SOAP Digital Signature is ON. |
| ↳ Canonicalization Algorithm | The XML canonicalization algorithm applied before signing. Visible when Enable SOAP Digital Signature is ON. |
Encryption
Select Encryption (GPG) or Decryption (GPG) as the subtype. Both subtypes are server-side only and cannot be executed from the browser.
| Subtype | Field | Description |
|---|---|---|
| Encryption (GPG) | Public Key | The armored GPG public key used to encrypt data. Required. |
| Decryption (GPG) | Private Key | The armored GPG private key used to decrypt data. Required. |
FTP
Select FTP or SFTP as the subtype.
FTP
Important: FTP transmits credentials in plain text and is not encrypted. Use SFTP for secure file transfers.
| Field | Description |
|---|---|
| Host | The FTP server hostname or IP address. Required. |
| Port | The port to connect on. Default: 21. |
| Username | The username for authentication. |
| Password | The password for authentication. |
SFTP
| Field | Description |
|---|---|
| Host | The SFTP server hostname or IP address. Required. |
| Private Key | A pem-encoded private key for key-based authentication. |
| Passphrase | The passphrase for the private key, if the key is encrypted. |
| Username | The username for authentication. |
| Password | The password for authentication. |
Request & Response
Defines default headers and body parameters added to every request made with this service.
| Section | Columns | Description |
|---|---|---|
| Request Headers | Header Name, Header Value | HTTP headers added to every outbound request. |
| Request Body | Body Name, Body Value | Body parameters added to every outbound request. |
| Allowed Response Headers | Header Name | Response headers allowed to be returned to the browser. |
Click Add Request Header, Add Request Body, or Add Response Header to add new rows.
Logging
Configures logging behavior for requests and responses made through this service.
| Setting | Description |
|---|---|
| Capture request and response bodies | When set to ON, this setting logs the full request and response bodies for each service call. |
| Retention Days | The number of days to retain captured logs. The field is blank by default; the helper text displays 30 as a suggested value. |
| PagerDuty Service Key | An optional PagerDuty key for alerting on service failures. |
Changelog
| Date | Change |
|---|---|
| — | Initial publication. |