> For the complete documentation index, see [llms.txt](https://docs.frends.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.frends.com/reference/frends-platform-api/platform-api-reference/models.md).

# Models

## The AcknowledgeInstanceErrorsQueryModel object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"AcknowledgeInstanceErrorsQueryModel":{"required":["reason","instanceIds"],"type":"object","properties":{"reason":{"type":"string"},"instanceIds":{"type":"array","items":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"}}}}}}}
```

## The AcmeProviderInfo object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"AcmeProviderInfo":{"required":["name","directoryUrl","requiresExternalAccountBinding"],"type":"object","properties":{"name":{"type":"string","description":"Provider name"},"directoryUrl":{"type":"string","description":"ACME directory URL"},"requiresExternalAccountBinding":{"type":"boolean","description":"Whether this provider requires external account binding (EAB)"},"issuerDomainName":{"type":["null","string"],"description":"Issuer domain name for the dns-persist-01 challenge's TXT record value; null when this provider doesn't offer the challenge type"}}}}}}
```

## The AcmeRevocationReason object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"AcmeRevocationReason":{"enum":["Unspecified","KeyCompromise","Superseded","CessationOfOperation"],"default":"Unspecified"}}}}
```

## The AgentEventViewModel object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"AgentEventViewModel":{"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"eventId":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"level":{"type":"string"},"utcTimestamp":{"type":"string","format":"date-time"},"category":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"source":{"type":"string"},"message":{"type":"string"}}}}}}
```

## The AgentRegistrationMode object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"AgentRegistrationMode":{"enum":["SelfHosted","Deployment","Cloud","StatefulSet"]}}}}
```

## The ApiAccessRuleType object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ApiAccessRuleType":{"enum":["Allow","Deny"]}}}}
```

## The ApiKey object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ApiKey":{"required":["name","environment","modifier"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"name":{"type":"string"},"value":{"type":"string","format":"uuid"},"environment":{"type":"string"},"modified":{"type":"string","format":"date-time"},"modifier":{"type":"string"},"groupAssignments":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyApiKeyGroupAssignment"}}}},"ApiPolicyApiKeyGroupAssignment":{"required":["apiKey","apiKeyGroup"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"apiKey":{"$ref":"#/components/schemas/ApiKey"},"apiKeyGroup":{"$ref":"#/components/schemas/ApiPolicyApiKeyGroup"}}},"ApiPolicyApiKeyGroup":{"required":["apiPolicy","name"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"apiPolicy":{"$ref":"#/components/schemas/ApiPolicy"},"name":{"type":"string"},"keyGroupAssignments":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyApiKeyGroupAssignment"}},"requestLimit":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"},"requestLimitWindowInMinutes":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"}}},"ApiPolicy":{"required":["uniqueIdentifier","name","modifier","apiKeyName","apiKeyLocation"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"uniqueIdentifier":{"type":"string","format":"uuid"},"name":{"type":"string"},"deletedUtc":{"type":["null","string"],"format":"date-time"},"description":{"type":["null","string"]},"modifier":{"type":"string"},"modifiedUtc":{"type":"string","format":"date-time"},"allowPublicAccess":{"type":"boolean"},"apiKeyName":{"type":"string"},"apiKeyLocation":{"$ref":"#/components/schemas/ParameterLocation"},"targetEndpoints":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyTargetEndpoint"}},"identities":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyIdentity"}},"apiKeyGroups":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyApiKeyGroup"}},"requestLoggings":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyRequestLogging"}}}},"ParameterLocation":{"enum":["Query","Header","Path","Cookie"]},"ApiPolicyTargetEndpoint":{"required":["apiPolicy","path"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"apiPolicy":{"$ref":"#/components/schemas/ApiPolicy"},"path":{"type":"string"},"method":{"$ref":"#/components/schemas/PolicyEndpointMethod"},"requestLimit":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"},"requestLimitWindowInMinutes":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"}}},"PolicyEndpointMethod":{"enum":["All","Get","Post","Put","Head","Delete","Patch","Options","Connect","Trace"]},"ApiPolicyIdentity":{"required":["apiPolicy"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"apiPolicy":{"$ref":"#/components/schemas/ApiPolicy"},"isPrivateApplication":{"type":"boolean"},"issuersJson":{"type":"string"},"name":{"type":"string"},"throttlingByClaim":{"type":["null","string"]},"priorityNumber":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"identityRules":{"type":["null","array"],"items":{"$ref":"#/components/schemas/ApiPolicyIdentityRule"}},"deployments":{},"requestLimit":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"},"requestLimitWindowInMinutes":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"}}},"ApiPolicyIdentityRule":{"required":["identity"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"identity":{"$ref":"#/components/schemas/ApiPolicyIdentity"},"ruleType":{"$ref":"#/components/schemas/ApiAccessRuleType"},"claim":{"type":"string"},"value":{"type":"string"},"matchType":{"$ref":"#/components/schemas/IdentityRuleMatchType"}}},"ApiAccessRuleType":{"enum":["Allow","Deny"]},"IdentityRuleMatchType":{"enum":["Exact","Exists","Regex"]},"ApiPolicyRequestLogging":{"required":["name","apiPolicy","loggingFieldsJson","ipLogging"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"name":{"type":"string"},"apiPolicy":{"$ref":"#/components/schemas/ApiPolicy"},"loggingFieldsJson":{"type":"string"},"ipLogging":{"$ref":"#/components/schemas/IpLoggingType"},"requestBodyMaxLengthKb":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"responseBodyMaxLengthKb":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"disableLogging":{"type":"boolean"},"deployments":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyRequestLoggingDeployment"}}}},"IpLoggingType":{"enum":["ClientIP","ClientIPXForwardedForFirst","ClientIPXForwardedForAll","Disable"]},"ApiPolicyRequestLoggingDeployment":{"required":["apiPolicyRequestLogging","agentGroupName","deployer"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"apiPolicyRequestLogging":{"$ref":"#/components/schemas/ApiPolicyRequestLogging"},"agentGroupName":{"type":"string"},"deployer":{"type":"string"},"deployedUtc":{"type":"string","format":"date-time"}}}}}}
```

## The ApiKeyViewModel object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ApiKeyViewModel":{"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"name":{"type":["null","string"]},"environment":{"type":["null","string"]},"value":{"type":"string","format":"uuid"}}}}}}
```

## The ApiPassthroughCreateModel object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ApiPassthroughCreateModel":{"required":["path","method","isDefault","corsEnabled","targetUrl","headers","allowedOrigins"],"type":"object","properties":{"path":{"type":["null","string"],"description":"Source API path for this passthrough configuration. Not used when IsDefault is set to true."},"method":{"type":["null","string"],"description":"HTTP method. Not used when IsDefault is set to true."},"isDefault":{"type":"boolean","description":"Is this configuration used for all paths and HTTP methods"},"corsEnabled":{"type":"boolean","description":"Is CORS enabled"},"targetUrl":{"description":"Target URL","$ref":"#/components/schemas/ApiPassthroughTarget"},"headers":{"type":["null","array"],"items":{"$ref":"#/components/schemas/ApiPassthroughHeader"},"description":"Header definitions"},"allowedOrigins":{"type":["null","array"],"items":{"type":"string"},"description":"Allowed origins. Used when CORS is enabled."}}},"ApiPassthroughTarget":{"required":["server","basePath","operationPath","query"],"type":"object","properties":{"server":{"type":"string","description":"Server part of the target URL"},"basePath":{"type":"string","description":"Base path of the target URL"},"operationPath":{"type":["null","string"],"description":"Operation path of the target URL"},"query":{"type":["null","string"],"description":"Query parameters of the target URL"}}},"ApiPassthroughHeader":{"required":["action","name","value"],"type":"object","properties":{"action":{"type":"string","description":"Header action (Add, Overwrite, Remove)"},"name":{"type":"string","description":"Header name"},"value":{"type":"string","description":"Header value"}}}}}}
```

## The ApiPassthroughEditModel object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ApiPassthroughEditModel":{"required":["corsEnabled","targetUrl","headers","allowedOrigins"],"type":"object","properties":{"corsEnabled":{"type":"boolean","description":"Is CORS enabled"},"targetUrl":{"description":"Target URL","$ref":"#/components/schemas/ApiPassthroughTarget"},"headers":{"type":["null","array"],"items":{"$ref":"#/components/schemas/ApiPassthroughHeader"},"description":"Header definitions"},"allowedOrigins":{"type":["null","array"],"items":{"type":"string"},"description":"Allowed origins. Used when CORS is enabled."}}},"ApiPassthroughTarget":{"required":["server","basePath","operationPath","query"],"type":"object","properties":{"server":{"type":"string","description":"Server part of the target URL"},"basePath":{"type":"string","description":"Base path of the target URL"},"operationPath":{"type":["null","string"],"description":"Operation path of the target URL"},"query":{"type":["null","string"],"description":"Query parameters of the target URL"}}},"ApiPassthroughHeader":{"required":["action","name","value"],"type":"object","properties":{"action":{"type":"string","description":"Header action (Add, Overwrite, Remove)"},"name":{"type":"string","description":"Header name"},"value":{"type":"string","description":"Header value"}}}}}}
```

## The ApiPassthroughHeader object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ApiPassthroughHeader":{"required":["action","name","value"],"type":"object","properties":{"action":{"type":"string","description":"Header action (Add, Overwrite, Remove)"},"name":{"type":"string","description":"Header name"},"value":{"type":"string","description":"Header value"}}}}}}
```

## The ApiPassthroughTarget object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ApiPassthroughTarget":{"required":["server","basePath","operationPath","query"],"type":"object","properties":{"server":{"type":"string","description":"Server part of the target URL"},"basePath":{"type":"string","description":"Base path of the target URL"},"operationPath":{"type":["null","string"],"description":"Operation path of the target URL"},"query":{"type":["null","string"],"description":"Query parameters of the target URL"}}}}}}
```

## The ApiPassthroughViewModel object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ApiPassthroughViewModel":{"required":["id","apiVersionId","modifier","modified","path","method","isDefault","corsEnabled","targetUrl","headers","allowedOrigins"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Unique identifier of the passthrough configuration","format":"int64"},"apiVersionId":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Unique identifier of the API version","format":"int64"},"modifier":{"type":"string","description":"User who last modified the configuration"},"modified":{"type":"string","description":"Time when configuration was last modified","format":"date-time"},"path":{"type":["null","string"],"description":"Source API path for this passthrough configuration. Not used when IsDefault is set to true."},"method":{"type":["null","string"],"description":"HTTP method. Not used when IsDefault is set to true."},"isDefault":{"type":"boolean","description":"Is this configuration used for all paths and HTTP methods"},"corsEnabled":{"type":"boolean","description":"Is CORS enabled"},"targetUrl":{"description":"Target URL","$ref":"#/components/schemas/ApiPassthroughTarget"},"headers":{"type":["null","array"],"items":{"$ref":"#/components/schemas/ApiPassthroughHeader"},"description":"Header definitions"},"allowedOrigins":{"type":["null","array"],"items":{"type":"string"},"description":"Allowed origins. Used when CORS is enabled."}}},"ApiPassthroughTarget":{"required":["server","basePath","operationPath","query"],"type":"object","properties":{"server":{"type":"string","description":"Server part of the target URL"},"basePath":{"type":"string","description":"Base path of the target URL"},"operationPath":{"type":["null","string"],"description":"Operation path of the target URL"},"query":{"type":["null","string"],"description":"Query parameters of the target URL"}}},"ApiPassthroughHeader":{"required":["action","name","value"],"type":"object","properties":{"action":{"type":"string","description":"Header action (Add, Overwrite, Remove)"},"name":{"type":"string","description":"Header name"},"value":{"type":"string","description":"Header value"}}}}}}
```

## The ApiPolicy object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ApiPolicy":{"required":["uniqueIdentifier","name","modifier","apiKeyName","apiKeyLocation"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"uniqueIdentifier":{"type":"string","format":"uuid"},"name":{"type":"string"},"deletedUtc":{"type":["null","string"],"format":"date-time"},"description":{"type":["null","string"]},"modifier":{"type":"string"},"modifiedUtc":{"type":"string","format":"date-time"},"allowPublicAccess":{"type":"boolean"},"apiKeyName":{"type":"string"},"apiKeyLocation":{"$ref":"#/components/schemas/ParameterLocation"},"targetEndpoints":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyTargetEndpoint"}},"identities":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyIdentity"}},"apiKeyGroups":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyApiKeyGroup"}},"requestLoggings":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyRequestLogging"}}}},"ParameterLocation":{"enum":["Query","Header","Path","Cookie"]},"ApiPolicyTargetEndpoint":{"required":["apiPolicy","path"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"apiPolicy":{"$ref":"#/components/schemas/ApiPolicy"},"path":{"type":"string"},"method":{"$ref":"#/components/schemas/PolicyEndpointMethod"},"requestLimit":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"},"requestLimitWindowInMinutes":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"}}},"ApiPolicyIdentity":{"required":["apiPolicy"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"apiPolicy":{"$ref":"#/components/schemas/ApiPolicy"},"isPrivateApplication":{"type":"boolean"},"issuersJson":{"type":"string"},"name":{"type":"string"},"throttlingByClaim":{"type":["null","string"]},"priorityNumber":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"identityRules":{"type":["null","array"],"items":{"$ref":"#/components/schemas/ApiPolicyIdentityRule"}},"deployments":{},"requestLimit":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"},"requestLimitWindowInMinutes":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"}}},"ApiPolicyIdentityRule":{"required":["identity"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"identity":{"$ref":"#/components/schemas/ApiPolicyIdentity"},"ruleType":{"$ref":"#/components/schemas/ApiAccessRuleType"},"claim":{"type":"string"},"value":{"type":"string"},"matchType":{"$ref":"#/components/schemas/IdentityRuleMatchType"}}},"ApiAccessRuleType":{"enum":["Allow","Deny"]},"IdentityRuleMatchType":{"enum":["Exact","Exists","Regex"]},"ApiPolicyApiKeyGroup":{"required":["apiPolicy","name"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"apiPolicy":{"$ref":"#/components/schemas/ApiPolicy"},"name":{"type":"string"},"keyGroupAssignments":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyApiKeyGroupAssignment"}},"requestLimit":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"},"requestLimitWindowInMinutes":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"}}},"ApiPolicyApiKeyGroupAssignment":{"required":["apiKey","apiKeyGroup"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"apiKey":{"$ref":"#/components/schemas/ApiKey"},"apiKeyGroup":{"$ref":"#/components/schemas/ApiPolicyApiKeyGroup"}}},"ApiKey":{"required":["name","environment","modifier"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"name":{"type":"string"},"value":{"type":"string","format":"uuid"},"environment":{"type":"string"},"modified":{"type":"string","format":"date-time"},"modifier":{"type":"string"},"groupAssignments":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyApiKeyGroupAssignment"}}}},"ApiPolicyRequestLogging":{"required":["name","apiPolicy","loggingFieldsJson","ipLogging"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"name":{"type":"string"},"apiPolicy":{"$ref":"#/components/schemas/ApiPolicy"},"loggingFieldsJson":{"type":"string"},"ipLogging":{"$ref":"#/components/schemas/IpLoggingType"},"requestBodyMaxLengthKb":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"responseBodyMaxLengthKb":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"disableLogging":{"type":"boolean"},"deployments":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyRequestLoggingDeployment"}}}},"IpLoggingType":{"enum":["ClientIP","ClientIPXForwardedForFirst","ClientIPXForwardedForAll","Disable"]},"ApiPolicyRequestLoggingDeployment":{"required":["apiPolicyRequestLogging","agentGroupName","deployer"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"apiPolicyRequestLogging":{"$ref":"#/components/schemas/ApiPolicyRequestLogging"},"agentGroupName":{"type":"string"},"deployer":{"type":"string"},"deployedUtc":{"type":"string","format":"date-time"}}},"PolicyEndpointMethod":{"enum":["All","Get","Post","Put","Head","Delete","Patch","Options","Connect","Trace"]}}}}
```

## The ApiPolicyApiKeyGroup object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ApiPolicyApiKeyGroup":{"required":["apiPolicy","name"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"apiPolicy":{"$ref":"#/components/schemas/ApiPolicy"},"name":{"type":"string"},"keyGroupAssignments":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyApiKeyGroupAssignment"}},"requestLimit":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"},"requestLimitWindowInMinutes":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"}}},"ApiPolicy":{"required":["uniqueIdentifier","name","modifier","apiKeyName","apiKeyLocation"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"uniqueIdentifier":{"type":"string","format":"uuid"},"name":{"type":"string"},"deletedUtc":{"type":["null","string"],"format":"date-time"},"description":{"type":["null","string"]},"modifier":{"type":"string"},"modifiedUtc":{"type":"string","format":"date-time"},"allowPublicAccess":{"type":"boolean"},"apiKeyName":{"type":"string"},"apiKeyLocation":{"$ref":"#/components/schemas/ParameterLocation"},"targetEndpoints":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyTargetEndpoint"}},"identities":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyIdentity"}},"apiKeyGroups":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyApiKeyGroup"}},"requestLoggings":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyRequestLogging"}}}},"ParameterLocation":{"enum":["Query","Header","Path","Cookie"]},"ApiPolicyTargetEndpoint":{"required":["apiPolicy","path"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"apiPolicy":{"$ref":"#/components/schemas/ApiPolicy"},"path":{"type":"string"},"method":{"$ref":"#/components/schemas/PolicyEndpointMethod"},"requestLimit":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"},"requestLimitWindowInMinutes":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"}}},"PolicyEndpointMethod":{"enum":["All","Get","Post","Put","Head","Delete","Patch","Options","Connect","Trace"]},"ApiPolicyIdentity":{"required":["apiPolicy"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"apiPolicy":{"$ref":"#/components/schemas/ApiPolicy"},"isPrivateApplication":{"type":"boolean"},"issuersJson":{"type":"string"},"name":{"type":"string"},"throttlingByClaim":{"type":["null","string"]},"priorityNumber":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"identityRules":{"type":["null","array"],"items":{"$ref":"#/components/schemas/ApiPolicyIdentityRule"}},"deployments":{},"requestLimit":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"},"requestLimitWindowInMinutes":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"}}},"ApiPolicyIdentityRule":{"required":["identity"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"identity":{"$ref":"#/components/schemas/ApiPolicyIdentity"},"ruleType":{"$ref":"#/components/schemas/ApiAccessRuleType"},"claim":{"type":"string"},"value":{"type":"string"},"matchType":{"$ref":"#/components/schemas/IdentityRuleMatchType"}}},"ApiAccessRuleType":{"enum":["Allow","Deny"]},"IdentityRuleMatchType":{"enum":["Exact","Exists","Regex"]},"ApiPolicyApiKeyGroupAssignment":{"required":["apiKey","apiKeyGroup"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"apiKey":{"$ref":"#/components/schemas/ApiKey"},"apiKeyGroup":{"$ref":"#/components/schemas/ApiPolicyApiKeyGroup"}}},"ApiKey":{"required":["name","environment","modifier"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"name":{"type":"string"},"value":{"type":"string","format":"uuid"},"environment":{"type":"string"},"modified":{"type":"string","format":"date-time"},"modifier":{"type":"string"},"groupAssignments":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyApiKeyGroupAssignment"}}}},"ApiPolicyRequestLogging":{"required":["name","apiPolicy","loggingFieldsJson","ipLogging"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"name":{"type":"string"},"apiPolicy":{"$ref":"#/components/schemas/ApiPolicy"},"loggingFieldsJson":{"type":"string"},"ipLogging":{"$ref":"#/components/schemas/IpLoggingType"},"requestBodyMaxLengthKb":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"responseBodyMaxLengthKb":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"disableLogging":{"type":"boolean"},"deployments":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyRequestLoggingDeployment"}}}},"IpLoggingType":{"enum":["ClientIP","ClientIPXForwardedForFirst","ClientIPXForwardedForAll","Disable"]},"ApiPolicyRequestLoggingDeployment":{"required":["apiPolicyRequestLogging","agentGroupName","deployer"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"apiPolicyRequestLogging":{"$ref":"#/components/schemas/ApiPolicyRequestLogging"},"agentGroupName":{"type":"string"},"deployer":{"type":"string"},"deployedUtc":{"type":"string","format":"date-time"}}}}}}
```

## The ApiPolicyApiKeyGroupAssignment object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ApiPolicyApiKeyGroupAssignment":{"required":["apiKey","apiKeyGroup"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"apiKey":{"$ref":"#/components/schemas/ApiKey"},"apiKeyGroup":{"$ref":"#/components/schemas/ApiPolicyApiKeyGroup"}}},"ApiKey":{"required":["name","environment","modifier"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"name":{"type":"string"},"value":{"type":"string","format":"uuid"},"environment":{"type":"string"},"modified":{"type":"string","format":"date-time"},"modifier":{"type":"string"},"groupAssignments":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyApiKeyGroupAssignment"}}}},"ApiPolicyApiKeyGroup":{"required":["apiPolicy","name"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"apiPolicy":{"$ref":"#/components/schemas/ApiPolicy"},"name":{"type":"string"},"keyGroupAssignments":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyApiKeyGroupAssignment"}},"requestLimit":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"},"requestLimitWindowInMinutes":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"}}},"ApiPolicy":{"required":["uniqueIdentifier","name","modifier","apiKeyName","apiKeyLocation"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"uniqueIdentifier":{"type":"string","format":"uuid"},"name":{"type":"string"},"deletedUtc":{"type":["null","string"],"format":"date-time"},"description":{"type":["null","string"]},"modifier":{"type":"string"},"modifiedUtc":{"type":"string","format":"date-time"},"allowPublicAccess":{"type":"boolean"},"apiKeyName":{"type":"string"},"apiKeyLocation":{"$ref":"#/components/schemas/ParameterLocation"},"targetEndpoints":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyTargetEndpoint"}},"identities":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyIdentity"}},"apiKeyGroups":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyApiKeyGroup"}},"requestLoggings":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyRequestLogging"}}}},"ParameterLocation":{"enum":["Query","Header","Path","Cookie"]},"ApiPolicyTargetEndpoint":{"required":["apiPolicy","path"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"apiPolicy":{"$ref":"#/components/schemas/ApiPolicy"},"path":{"type":"string"},"method":{"$ref":"#/components/schemas/PolicyEndpointMethod"},"requestLimit":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"},"requestLimitWindowInMinutes":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"}}},"PolicyEndpointMethod":{"enum":["All","Get","Post","Put","Head","Delete","Patch","Options","Connect","Trace"]},"ApiPolicyIdentity":{"required":["apiPolicy"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"apiPolicy":{"$ref":"#/components/schemas/ApiPolicy"},"isPrivateApplication":{"type":"boolean"},"issuersJson":{"type":"string"},"name":{"type":"string"},"throttlingByClaim":{"type":["null","string"]},"priorityNumber":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"identityRules":{"type":["null","array"],"items":{"$ref":"#/components/schemas/ApiPolicyIdentityRule"}},"deployments":{},"requestLimit":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"},"requestLimitWindowInMinutes":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"}}},"ApiPolicyIdentityRule":{"required":["identity"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"identity":{"$ref":"#/components/schemas/ApiPolicyIdentity"},"ruleType":{"$ref":"#/components/schemas/ApiAccessRuleType"},"claim":{"type":"string"},"value":{"type":"string"},"matchType":{"$ref":"#/components/schemas/IdentityRuleMatchType"}}},"ApiAccessRuleType":{"enum":["Allow","Deny"]},"IdentityRuleMatchType":{"enum":["Exact","Exists","Regex"]},"ApiPolicyRequestLogging":{"required":["name","apiPolicy","loggingFieldsJson","ipLogging"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"name":{"type":"string"},"apiPolicy":{"$ref":"#/components/schemas/ApiPolicy"},"loggingFieldsJson":{"type":"string"},"ipLogging":{"$ref":"#/components/schemas/IpLoggingType"},"requestBodyMaxLengthKb":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"responseBodyMaxLengthKb":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"disableLogging":{"type":"boolean"},"deployments":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyRequestLoggingDeployment"}}}},"IpLoggingType":{"enum":["ClientIP","ClientIPXForwardedForFirst","ClientIPXForwardedForAll","Disable"]},"ApiPolicyRequestLoggingDeployment":{"required":["apiPolicyRequestLogging","agentGroupName","deployer"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"apiPolicyRequestLogging":{"$ref":"#/components/schemas/ApiPolicyRequestLogging"},"agentGroupName":{"type":"string"},"deployer":{"type":"string"},"deployedUtc":{"type":"string","format":"date-time"}}}}}}
```

## The ApiPolicyApiKeyGroupAssignmentSaveModel object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ApiPolicyApiKeyGroupAssignmentSaveModel":{"required":["apiKey"],"type":"object","properties":{"apiKey":{"description":"The API key","$ref":"#/components/schemas/ApiPolicyApiKeySaveModel"}}},"ApiPolicyApiKeySaveModel":{"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"The API key identifier","format":"int64"}}}}}}
```

## The ApiPolicyApiKeyGroupAssignmentViewModel object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ApiPolicyApiKeyGroupAssignmentViewModel":{"required":["apiKey"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"The identifier of the assignment","format":"int64"},"apiKey":{"description":"The API key","$ref":"#/components/schemas/ApiKeyViewModel"}}},"ApiKeyViewModel":{"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"name":{"type":["null","string"]},"environment":{"type":["null","string"]},"value":{"type":"string","format":"uuid"}}}}}}
```

## The ApiPolicyApiKeyGroupSaveModel object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ApiPolicyApiKeyGroupSaveModel":{"required":["apiPolicyApiKeyGroupAssignments","name"],"type":"object","properties":{"apiPolicyApiKeyGroupAssignments":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyApiKeyGroupAssignmentSaveModel"},"description":"The API key group assignments"},"name":{"type":"string","description":"The name of the API key group"},"requestLimit":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"description":"The maximum amount of requests. Not null value requires RequestLimitWindowInMinutes to be set.","format":"int32"},"requestLimitWindowInMinutes":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"description":"The request limit window in minutes. Not null value requires RequestLimit to be set.","format":"int32"}}},"ApiPolicyApiKeyGroupAssignmentSaveModel":{"required":["apiKey"],"type":"object","properties":{"apiKey":{"description":"The API key","$ref":"#/components/schemas/ApiPolicyApiKeySaveModel"}}},"ApiPolicyApiKeySaveModel":{"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"The API key identifier","format":"int64"}}}}}}
```

## The ApiPolicyApiKeyGroupViewModel object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ApiPolicyApiKeyGroupViewModel":{"required":["name"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"The unique identifier of the API key group","format":"int64"},"apiPolicyApiKeyGroupAssignments":{"type":["null","array"],"items":{"$ref":"#/components/schemas/ApiPolicyApiKeyGroupAssignmentViewModel"},"description":"The API group assignments"},"name":{"type":"string","description":"The name of the API key group"},"requestLimit":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"description":"The maximum amount of requests. Not null value requires RequestLimitWindowInMinutes to be set.","format":"int32"},"requestLimitWindowInMinutes":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"description":"The request limit window in minutes. Not null value requires RequestLimit to be set.","format":"int32"}}},"ApiPolicyApiKeyGroupAssignmentViewModel":{"required":["apiKey"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"The identifier of the assignment","format":"int64"},"apiKey":{"description":"The API key","$ref":"#/components/schemas/ApiKeyViewModel"}}},"ApiKeyViewModel":{"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"name":{"type":["null","string"]},"environment":{"type":["null","string"]},"value":{"type":"string","format":"uuid"}}}}}}
```

## The ApiPolicyApiKeySaveModel object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ApiPolicyApiKeySaveModel":{"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"The API key identifier","format":"int64"}}}}}}
```

## The ApiPolicyDeploymentSaveModel object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ApiPolicyDeploymentSaveModel":{"required":["agentGroupName"],"type":"object","properties":{"agentGroupName":{"type":"string","description":"The Agent Group associated with the deployment"}}}}}}
```

## The ApiPolicyDeploymentViewModel object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ApiPolicyDeploymentViewModel":{"required":["agentGroupName"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"The unique identifier of the deployment","format":"int64"},"deployerUserName":{"type":"string","description":"The username of the deployer"},"deployedUtc":{"type":"string","description":"The timestamp when the deployment occurred","format":"date-time"},"agentGroupName":{"type":"string","description":"The Agent Group associated with the deployment"}}}}}}
```

## The ApiPolicyIdentity object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ApiPolicyIdentity":{"required":["apiPolicy"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"apiPolicy":{"$ref":"#/components/schemas/ApiPolicy"},"isPrivateApplication":{"type":"boolean"},"issuersJson":{"type":"string"},"name":{"type":"string"},"throttlingByClaim":{"type":["null","string"]},"priorityNumber":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"identityRules":{"type":["null","array"],"items":{"$ref":"#/components/schemas/ApiPolicyIdentityRule"}},"deployments":{},"requestLimit":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"},"requestLimitWindowInMinutes":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"}}},"ApiPolicy":{"required":["uniqueIdentifier","name","modifier","apiKeyName","apiKeyLocation"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"uniqueIdentifier":{"type":"string","format":"uuid"},"name":{"type":"string"},"deletedUtc":{"type":["null","string"],"format":"date-time"},"description":{"type":["null","string"]},"modifier":{"type":"string"},"modifiedUtc":{"type":"string","format":"date-time"},"allowPublicAccess":{"type":"boolean"},"apiKeyName":{"type":"string"},"apiKeyLocation":{"$ref":"#/components/schemas/ParameterLocation"},"targetEndpoints":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyTargetEndpoint"}},"identities":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyIdentity"}},"apiKeyGroups":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyApiKeyGroup"}},"requestLoggings":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyRequestLogging"}}}},"ParameterLocation":{"enum":["Query","Header","Path","Cookie"]},"ApiPolicyTargetEndpoint":{"required":["apiPolicy","path"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"apiPolicy":{"$ref":"#/components/schemas/ApiPolicy"},"path":{"type":"string"},"method":{"$ref":"#/components/schemas/PolicyEndpointMethod"},"requestLimit":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"},"requestLimitWindowInMinutes":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"}}},"PolicyEndpointMethod":{"enum":["All","Get","Post","Put","Head","Delete","Patch","Options","Connect","Trace"]},"ApiPolicyIdentityRule":{"required":["identity"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"identity":{"$ref":"#/components/schemas/ApiPolicyIdentity"},"ruleType":{"$ref":"#/components/schemas/ApiAccessRuleType"},"claim":{"type":"string"},"value":{"type":"string"},"matchType":{"$ref":"#/components/schemas/IdentityRuleMatchType"}}},"ApiAccessRuleType":{"enum":["Allow","Deny"]},"IdentityRuleMatchType":{"enum":["Exact","Exists","Regex"]},"ApiPolicyApiKeyGroup":{"required":["apiPolicy","name"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"apiPolicy":{"$ref":"#/components/schemas/ApiPolicy"},"name":{"type":"string"},"keyGroupAssignments":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyApiKeyGroupAssignment"}},"requestLimit":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"},"requestLimitWindowInMinutes":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"}}},"ApiPolicyApiKeyGroupAssignment":{"required":["apiKey","apiKeyGroup"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"apiKey":{"$ref":"#/components/schemas/ApiKey"},"apiKeyGroup":{"$ref":"#/components/schemas/ApiPolicyApiKeyGroup"}}},"ApiKey":{"required":["name","environment","modifier"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"name":{"type":"string"},"value":{"type":"string","format":"uuid"},"environment":{"type":"string"},"modified":{"type":"string","format":"date-time"},"modifier":{"type":"string"},"groupAssignments":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyApiKeyGroupAssignment"}}}},"ApiPolicyRequestLogging":{"required":["name","apiPolicy","loggingFieldsJson","ipLogging"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"name":{"type":"string"},"apiPolicy":{"$ref":"#/components/schemas/ApiPolicy"},"loggingFieldsJson":{"type":"string"},"ipLogging":{"$ref":"#/components/schemas/IpLoggingType"},"requestBodyMaxLengthKb":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"responseBodyMaxLengthKb":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"disableLogging":{"type":"boolean"},"deployments":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyRequestLoggingDeployment"}}}},"IpLoggingType":{"enum":["ClientIP","ClientIPXForwardedForFirst","ClientIPXForwardedForAll","Disable"]},"ApiPolicyRequestLoggingDeployment":{"required":["apiPolicyRequestLogging","agentGroupName","deployer"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"apiPolicyRequestLogging":{"$ref":"#/components/schemas/ApiPolicyRequestLogging"},"agentGroupName":{"type":"string"},"deployer":{"type":"string"},"deployedUtc":{"type":"string","format":"date-time"}}}}}}
```

## The ApiPolicyIdentityRule object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ApiPolicyIdentityRule":{"required":["identity"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"identity":{"$ref":"#/components/schemas/ApiPolicyIdentity"},"ruleType":{"$ref":"#/components/schemas/ApiAccessRuleType"},"claim":{"type":"string"},"value":{"type":"string"},"matchType":{"$ref":"#/components/schemas/IdentityRuleMatchType"}}},"ApiPolicyIdentity":{"required":["apiPolicy"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"apiPolicy":{"$ref":"#/components/schemas/ApiPolicy"},"isPrivateApplication":{"type":"boolean"},"issuersJson":{"type":"string"},"name":{"type":"string"},"throttlingByClaim":{"type":["null","string"]},"priorityNumber":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"identityRules":{"type":["null","array"],"items":{"$ref":"#/components/schemas/ApiPolicyIdentityRule"}},"deployments":{},"requestLimit":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"},"requestLimitWindowInMinutes":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"}}},"ApiPolicy":{"required":["uniqueIdentifier","name","modifier","apiKeyName","apiKeyLocation"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"uniqueIdentifier":{"type":"string","format":"uuid"},"name":{"type":"string"},"deletedUtc":{"type":["null","string"],"format":"date-time"},"description":{"type":["null","string"]},"modifier":{"type":"string"},"modifiedUtc":{"type":"string","format":"date-time"},"allowPublicAccess":{"type":"boolean"},"apiKeyName":{"type":"string"},"apiKeyLocation":{"$ref":"#/components/schemas/ParameterLocation"},"targetEndpoints":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyTargetEndpoint"}},"identities":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyIdentity"}},"apiKeyGroups":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyApiKeyGroup"}},"requestLoggings":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyRequestLogging"}}}},"ParameterLocation":{"enum":["Query","Header","Path","Cookie"]},"ApiPolicyTargetEndpoint":{"required":["apiPolicy","path"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"apiPolicy":{"$ref":"#/components/schemas/ApiPolicy"},"path":{"type":"string"},"method":{"$ref":"#/components/schemas/PolicyEndpointMethod"},"requestLimit":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"},"requestLimitWindowInMinutes":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"}}},"PolicyEndpointMethod":{"enum":["All","Get","Post","Put","Head","Delete","Patch","Options","Connect","Trace"]},"ApiPolicyApiKeyGroup":{"required":["apiPolicy","name"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"apiPolicy":{"$ref":"#/components/schemas/ApiPolicy"},"name":{"type":"string"},"keyGroupAssignments":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyApiKeyGroupAssignment"}},"requestLimit":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"},"requestLimitWindowInMinutes":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"}}},"ApiPolicyApiKeyGroupAssignment":{"required":["apiKey","apiKeyGroup"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"apiKey":{"$ref":"#/components/schemas/ApiKey"},"apiKeyGroup":{"$ref":"#/components/schemas/ApiPolicyApiKeyGroup"}}},"ApiKey":{"required":["name","environment","modifier"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"name":{"type":"string"},"value":{"type":"string","format":"uuid"},"environment":{"type":"string"},"modified":{"type":"string","format":"date-time"},"modifier":{"type":"string"},"groupAssignments":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyApiKeyGroupAssignment"}}}},"ApiPolicyRequestLogging":{"required":["name","apiPolicy","loggingFieldsJson","ipLogging"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"name":{"type":"string"},"apiPolicy":{"$ref":"#/components/schemas/ApiPolicy"},"loggingFieldsJson":{"type":"string"},"ipLogging":{"$ref":"#/components/schemas/IpLoggingType"},"requestBodyMaxLengthKb":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"responseBodyMaxLengthKb":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"disableLogging":{"type":"boolean"},"deployments":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyRequestLoggingDeployment"}}}},"IpLoggingType":{"enum":["ClientIP","ClientIPXForwardedForFirst","ClientIPXForwardedForAll","Disable"]},"ApiPolicyRequestLoggingDeployment":{"required":["apiPolicyRequestLogging","agentGroupName","deployer"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"apiPolicyRequestLogging":{"$ref":"#/components/schemas/ApiPolicyRequestLogging"},"agentGroupName":{"type":"string"},"deployer":{"type":"string"},"deployedUtc":{"type":"string","format":"date-time"}}},"ApiAccessRuleType":{"enum":["Allow","Deny"]},"IdentityRuleMatchType":{"enum":["Exact","Exists","Regex"]}}}}
```

## The ApiPolicyIdentityRuleSaveModel object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ApiPolicyIdentityRuleSaveModel":{"required":["claim"],"type":"object","properties":{"ruleType":{"description":"The type of access rule","$ref":"#/components/schemas/ApiAccessRuleType"},"claim":{"type":"string","description":"The claim associated with the identity rule"},"value":{"type":["null","string"],"description":"The value associated with the identity rule"},"matchType":{"description":"The match type of the identity rule","$ref":"#/components/schemas/IdentityRuleMatchType"}}},"ApiAccessRuleType":{"enum":["Allow","Deny"]},"IdentityRuleMatchType":{"enum":["Exact","Exists","Regex"]}}}}
```

## The ApiPolicyIdentityRuleViewModel object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ApiPolicyIdentityRuleViewModel":{"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"The unique identifier of the identity rule","format":"int64"},"ruleType":{"description":"The type of access rule","$ref":"#/components/schemas/ApiAccessRuleType"},"claim":{"type":["null","string"],"description":"The claim associated with the identity rule"},"value":{"type":["null","string"],"description":"The value associated with the identity rule"},"matchType":{"description":"The match type of the identity rule","$ref":"#/components/schemas/IdentityRuleMatchType"}}},"ApiAccessRuleType":{"enum":["Allow","Deny"]},"IdentityRuleMatchType":{"enum":["Exact","Exists","Regex"]}}}}
```

## The ApiPolicyIdentitySaveModel object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ApiPolicyIdentitySaveModel":{"required":["deployments","issuers","name"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"description":"The unique identifier of the identity. Only provide a value when updating.","format":"int64"},"identityRules":{"type":["null","array"],"items":{"$ref":"#/components/schemas/ApiPolicyIdentityRuleSaveModel"},"description":"The list of identity rules"},"deployments":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyDeploymentSaveModel"},"description":"The list of deployments associated with the identity"},"isPrivateApplication":{"type":"boolean","description":"Determines if it is a private application"},"issuers":{"description":"The issuers of the identity","$ref":"#/components/schemas/JsonArray"},"name":{"type":"string","description":"The name of the identity"},"throttlingByClaim":{"type":["null","string"],"description":"The throttling by claim for the identity"},"priorityNumber":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"In case of 2 or more matching identities, determines which identity to use. Lower number will be selected.","format":"int32"},"requestLimit":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"description":"The maximum amount of requests. Not null value requires RequestLimitWindowInMinutes to be set.","format":"int32"},"requestLimitWindowInMinutes":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"description":"The request limit window in minutes. Not null value requires RequestLimit to be set.","format":"int32"}}},"ApiPolicyIdentityRuleSaveModel":{"required":["claim"],"type":"object","properties":{"ruleType":{"description":"The type of access rule","$ref":"#/components/schemas/ApiAccessRuleType"},"claim":{"type":"string","description":"The claim associated with the identity rule"},"value":{"type":["null","string"],"description":"The value associated with the identity rule"},"matchType":{"description":"The match type of the identity rule","$ref":"#/components/schemas/IdentityRuleMatchType"}}},"ApiAccessRuleType":{"enum":["Allow","Deny"]},"IdentityRuleMatchType":{"enum":["Exact","Exists","Regex"]},"ApiPolicyDeploymentSaveModel":{"required":["agentGroupName"],"type":"object","properties":{"agentGroupName":{"type":"string","description":"The Agent Group associated with the deployment"}}},"JsonArray":{"type":"array"}}}}
```

## The ApiPolicyIdentityViewModel object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ApiPolicyIdentityViewModel":{"required":["issuers","name"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"The unique identifier of the identity","format":"int64"},"identityRules":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyIdentityRuleViewModel"}},"deployments":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyDeploymentViewModel"},"description":"The list of deployments associated with the identity"},"isPrivateApplication":{"type":"boolean","description":"Determines if it is a private application"},"issuers":{"description":"The issuers of the identity","$ref":"#/components/schemas/JsonArray"},"name":{"type":"string","description":"The name of the identity"},"throttlingByClaim":{"type":["null","string"],"description":"The throttling by claim for the identity"},"priorityNumber":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"In case of 2 or more matching identities, determines which identity to use. Lower number will be selected.","format":"int32"},"requestLimit":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"description":"The maximum amount of requests. Not null value requires RequestLimitWindowInMinutes to be set.","format":"int32"},"requestLimitWindowInMinutes":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"description":"The request limit window in minutes. Not null value requires RequestLimit to be set.","format":"int32"}}},"ApiPolicyIdentityRuleViewModel":{"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"The unique identifier of the identity rule","format":"int64"},"ruleType":{"description":"The type of access rule","$ref":"#/components/schemas/ApiAccessRuleType"},"claim":{"type":["null","string"],"description":"The claim associated with the identity rule"},"value":{"type":["null","string"],"description":"The value associated with the identity rule"},"matchType":{"description":"The match type of the identity rule","$ref":"#/components/schemas/IdentityRuleMatchType"}}},"ApiAccessRuleType":{"enum":["Allow","Deny"]},"IdentityRuleMatchType":{"enum":["Exact","Exists","Regex"]},"ApiPolicyDeploymentViewModel":{"required":["agentGroupName"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"The unique identifier of the deployment","format":"int64"},"deployerUserName":{"type":"string","description":"The username of the deployer"},"deployedUtc":{"type":"string","description":"The timestamp when the deployment occurred","format":"date-time"},"agentGroupName":{"type":"string","description":"The Agent Group associated with the deployment"}}},"JsonArray":{"type":"array"}}}}
```

## The ApiPolicyListItemViewModel object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ApiPolicyListItemViewModel":{"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"The unique identifier of the API policy","format":"int64"},"name":{"type":"string","description":"The name of the policy"},"description":{"type":["null","string"],"description":"The description of the policy"}}}}}}
```

## The ApiPolicyRequestLogging object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ApiPolicyRequestLogging":{"required":["name","apiPolicy","loggingFieldsJson","ipLogging"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"name":{"type":"string"},"apiPolicy":{"$ref":"#/components/schemas/ApiPolicy"},"loggingFieldsJson":{"type":"string"},"ipLogging":{"$ref":"#/components/schemas/IpLoggingType"},"requestBodyMaxLengthKb":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"responseBodyMaxLengthKb":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"disableLogging":{"type":"boolean"},"deployments":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyRequestLoggingDeployment"}}}},"ApiPolicy":{"required":["uniqueIdentifier","name","modifier","apiKeyName","apiKeyLocation"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"uniqueIdentifier":{"type":"string","format":"uuid"},"name":{"type":"string"},"deletedUtc":{"type":["null","string"],"format":"date-time"},"description":{"type":["null","string"]},"modifier":{"type":"string"},"modifiedUtc":{"type":"string","format":"date-time"},"allowPublicAccess":{"type":"boolean"},"apiKeyName":{"type":"string"},"apiKeyLocation":{"$ref":"#/components/schemas/ParameterLocation"},"targetEndpoints":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyTargetEndpoint"}},"identities":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyIdentity"}},"apiKeyGroups":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyApiKeyGroup"}},"requestLoggings":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyRequestLogging"}}}},"ParameterLocation":{"enum":["Query","Header","Path","Cookie"]},"ApiPolicyTargetEndpoint":{"required":["apiPolicy","path"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"apiPolicy":{"$ref":"#/components/schemas/ApiPolicy"},"path":{"type":"string"},"method":{"$ref":"#/components/schemas/PolicyEndpointMethod"},"requestLimit":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"},"requestLimitWindowInMinutes":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"}}},"PolicyEndpointMethod":{"enum":["All","Get","Post","Put","Head","Delete","Patch","Options","Connect","Trace"]},"ApiPolicyIdentity":{"required":["apiPolicy"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"apiPolicy":{"$ref":"#/components/schemas/ApiPolicy"},"isPrivateApplication":{"type":"boolean"},"issuersJson":{"type":"string"},"name":{"type":"string"},"throttlingByClaim":{"type":["null","string"]},"priorityNumber":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"identityRules":{"type":["null","array"],"items":{"$ref":"#/components/schemas/ApiPolicyIdentityRule"}},"deployments":{},"requestLimit":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"},"requestLimitWindowInMinutes":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"}}},"ApiPolicyIdentityRule":{"required":["identity"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"identity":{"$ref":"#/components/schemas/ApiPolicyIdentity"},"ruleType":{"$ref":"#/components/schemas/ApiAccessRuleType"},"claim":{"type":"string"},"value":{"type":"string"},"matchType":{"$ref":"#/components/schemas/IdentityRuleMatchType"}}},"ApiAccessRuleType":{"enum":["Allow","Deny"]},"IdentityRuleMatchType":{"enum":["Exact","Exists","Regex"]},"ApiPolicyApiKeyGroup":{"required":["apiPolicy","name"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"apiPolicy":{"$ref":"#/components/schemas/ApiPolicy"},"name":{"type":"string"},"keyGroupAssignments":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyApiKeyGroupAssignment"}},"requestLimit":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"},"requestLimitWindowInMinutes":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"}}},"ApiPolicyApiKeyGroupAssignment":{"required":["apiKey","apiKeyGroup"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"apiKey":{"$ref":"#/components/schemas/ApiKey"},"apiKeyGroup":{"$ref":"#/components/schemas/ApiPolicyApiKeyGroup"}}},"ApiKey":{"required":["name","environment","modifier"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"name":{"type":"string"},"value":{"type":"string","format":"uuid"},"environment":{"type":"string"},"modified":{"type":"string","format":"date-time"},"modifier":{"type":"string"},"groupAssignments":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyApiKeyGroupAssignment"}}}},"IpLoggingType":{"enum":["ClientIP","ClientIPXForwardedForFirst","ClientIPXForwardedForAll","Disable"]},"ApiPolicyRequestLoggingDeployment":{"required":["apiPolicyRequestLogging","agentGroupName","deployer"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"apiPolicyRequestLogging":{"$ref":"#/components/schemas/ApiPolicyRequestLogging"},"agentGroupName":{"type":"string"},"deployer":{"type":"string"},"deployedUtc":{"type":"string","format":"date-time"}}}}}}
```

## The ApiPolicyRequestLoggingDeployment object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ApiPolicyRequestLoggingDeployment":{"required":["apiPolicyRequestLogging","agentGroupName","deployer"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"apiPolicyRequestLogging":{"$ref":"#/components/schemas/ApiPolicyRequestLogging"},"agentGroupName":{"type":"string"},"deployer":{"type":"string"},"deployedUtc":{"type":"string","format":"date-time"}}},"ApiPolicyRequestLogging":{"required":["name","apiPolicy","loggingFieldsJson","ipLogging"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"name":{"type":"string"},"apiPolicy":{"$ref":"#/components/schemas/ApiPolicy"},"loggingFieldsJson":{"type":"string"},"ipLogging":{"$ref":"#/components/schemas/IpLoggingType"},"requestBodyMaxLengthKb":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"responseBodyMaxLengthKb":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"disableLogging":{"type":"boolean"},"deployments":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyRequestLoggingDeployment"}}}},"ApiPolicy":{"required":["uniqueIdentifier","name","modifier","apiKeyName","apiKeyLocation"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"uniqueIdentifier":{"type":"string","format":"uuid"},"name":{"type":"string"},"deletedUtc":{"type":["null","string"],"format":"date-time"},"description":{"type":["null","string"]},"modifier":{"type":"string"},"modifiedUtc":{"type":"string","format":"date-time"},"allowPublicAccess":{"type":"boolean"},"apiKeyName":{"type":"string"},"apiKeyLocation":{"$ref":"#/components/schemas/ParameterLocation"},"targetEndpoints":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyTargetEndpoint"}},"identities":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyIdentity"}},"apiKeyGroups":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyApiKeyGroup"}},"requestLoggings":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyRequestLogging"}}}},"ParameterLocation":{"enum":["Query","Header","Path","Cookie"]},"ApiPolicyTargetEndpoint":{"required":["apiPolicy","path"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"apiPolicy":{"$ref":"#/components/schemas/ApiPolicy"},"path":{"type":"string"},"method":{"$ref":"#/components/schemas/PolicyEndpointMethod"},"requestLimit":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"},"requestLimitWindowInMinutes":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"}}},"PolicyEndpointMethod":{"enum":["All","Get","Post","Put","Head","Delete","Patch","Options","Connect","Trace"]},"ApiPolicyIdentity":{"required":["apiPolicy"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"apiPolicy":{"$ref":"#/components/schemas/ApiPolicy"},"isPrivateApplication":{"type":"boolean"},"issuersJson":{"type":"string"},"name":{"type":"string"},"throttlingByClaim":{"type":["null","string"]},"priorityNumber":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"identityRules":{"type":["null","array"],"items":{"$ref":"#/components/schemas/ApiPolicyIdentityRule"}},"deployments":{},"requestLimit":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"},"requestLimitWindowInMinutes":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"}}},"ApiPolicyIdentityRule":{"required":["identity"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"identity":{"$ref":"#/components/schemas/ApiPolicyIdentity"},"ruleType":{"$ref":"#/components/schemas/ApiAccessRuleType"},"claim":{"type":"string"},"value":{"type":"string"},"matchType":{"$ref":"#/components/schemas/IdentityRuleMatchType"}}},"ApiAccessRuleType":{"enum":["Allow","Deny"]},"IdentityRuleMatchType":{"enum":["Exact","Exists","Regex"]},"ApiPolicyApiKeyGroup":{"required":["apiPolicy","name"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"apiPolicy":{"$ref":"#/components/schemas/ApiPolicy"},"name":{"type":"string"},"keyGroupAssignments":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyApiKeyGroupAssignment"}},"requestLimit":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"},"requestLimitWindowInMinutes":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"}}},"ApiPolicyApiKeyGroupAssignment":{"required":["apiKey","apiKeyGroup"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"apiKey":{"$ref":"#/components/schemas/ApiKey"},"apiKeyGroup":{"$ref":"#/components/schemas/ApiPolicyApiKeyGroup"}}},"ApiKey":{"required":["name","environment","modifier"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"name":{"type":"string"},"value":{"type":"string","format":"uuid"},"environment":{"type":"string"},"modified":{"type":"string","format":"date-time"},"modifier":{"type":"string"},"groupAssignments":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyApiKeyGroupAssignment"}}}},"IpLoggingType":{"enum":["ClientIP","ClientIPXForwardedForFirst","ClientIPXForwardedForAll","Disable"]}}}}
```

## The ApiPolicyRequestLoggingSaveModel object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ApiPolicyRequestLoggingSaveModel":{"required":["deployments","name","loggingFields"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"description":"The unique identifier of the request logging. Only provide a value when updating.","format":"int64"},"deployments":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyDeploymentSaveModel"},"description":"The list of deployments associated with the request logging"},"name":{"type":"string","description":"The name of the request logging"},"loggingFields":{"description":"The fields logged by request logging","$ref":"#/components/schemas/JsonArray"},"ipLogging":{"description":"IpLoggingType of the request logging","$ref":"#/components/schemas/IpLoggingType"},"requestBodyMaxLengthKb":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Request body maximum length for request logging","format":"int32"},"responseBodyMaxLengthKb":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Response body maximum length for request logging","format":"int32"},"disableLogging":{"type":"boolean","description":"Disable logging for request logging"}}},"ApiPolicyDeploymentSaveModel":{"required":["agentGroupName"],"type":"object","properties":{"agentGroupName":{"type":"string","description":"The Agent Group associated with the deployment"}}},"JsonArray":{"type":"array"},"IpLoggingType":{"enum":["ClientIP","ClientIPXForwardedForFirst","ClientIPXForwardedForAll","Disable"]}}}}
```

## The ApiPolicyRequestLoggingViewModel object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ApiPolicyRequestLoggingViewModel":{"required":["name","loggingFields"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"The unique identifier of the request logging","format":"int64"},"deployments":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyDeploymentViewModel"},"description":"The list of deployments associated with the request logging"},"name":{"type":"string","description":"The name of the request logging"},"loggingFields":{"description":"The fields logged by request logging","$ref":"#/components/schemas/JsonArray"},"ipLogging":{"description":"IpLoggingType of the request logging","$ref":"#/components/schemas/IpLoggingType"},"requestBodyMaxLengthKb":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Request body maximum length for request logging","format":"int32"},"responseBodyMaxLengthKb":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Response body maximum length for request logging","format":"int32"},"disableLogging":{"type":"boolean","description":"Disable logging for request logging"}}},"ApiPolicyDeploymentViewModel":{"required":["agentGroupName"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"The unique identifier of the deployment","format":"int64"},"deployerUserName":{"type":"string","description":"The username of the deployer"},"deployedUtc":{"type":"string","description":"The timestamp when the deployment occurred","format":"date-time"},"agentGroupName":{"type":"string","description":"The Agent Group associated with the deployment"}}},"JsonArray":{"type":"array"},"IpLoggingType":{"enum":["ClientIP","ClientIPXForwardedForFirst","ClientIPXForwardedForAll","Disable"]}}}}
```

## The ApiPolicySaveModel object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ApiPolicySaveModel":{"required":["targetEndpoints","name"],"type":"object","properties":{"targetEndpoints":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyTargetEndpointSaveModel"},"description":"The list of target endpoints associated with the policy"},"identities":{"type":["null","array"],"items":{"$ref":"#/components/schemas/ApiPolicyIdentitySaveModel"},"description":"The list of identities associated with the policy"},"apiKeyGroups":{"type":["null","array"],"items":{"$ref":"#/components/schemas/ApiPolicyApiKeyGroupSaveModel"},"description":"The list of API key groups associated with the policy"},"publicAccessDeployments":{"type":["null","array"],"items":{"$ref":"#/components/schemas/ApiPolicyDeploymentSaveModel"},"description":"The list of deployments associated with the public access identity"},"requestLoggingOptions":{"type":["null","array"],"items":{"$ref":"#/components/schemas/ApiPolicyRequestLoggingSaveModel"},"description":"The list of request logging options associated with the api policy"},"name":{"type":"string","description":"The name of the policy"},"description":{"type":["null","string"],"description":"The description of the policy"},"tags":{"type":["null","array"],"items":{"type":"string"},"description":"The tags of the policy"},"allowPublicAccess":{"type":"boolean","description":"Determines if public access is allowed"},"apiKeyName":{"type":"string","description":"The name of the API key"},"apiKeyLocation":{"description":"The location of the API key","$ref":"#/components/schemas/ParameterLocation"}}},"ApiPolicyTargetEndpointSaveModel":{"required":["path"],"type":"object","properties":{"path":{"type":"string","description":"The path of the target endpoint"},"method":{"description":"The HTTP method of the target endpoint","$ref":"#/components/schemas/PolicyEndpointMethod"},"requestLimit":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"description":"The maximum amount of requests. Not null value requires RequestLimitWindowInMinutes to be set.","format":"int32"},"requestLimitWindowInMinutes":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"description":"The request limit window in minutes. Not null value requires RequestLimit to be set.","format":"int32"}}},"PolicyEndpointMethod":{"enum":["All","Get","Post","Put","Head","Delete","Patch","Options","Connect","Trace"]},"ApiPolicyIdentitySaveModel":{"required":["deployments","issuers","name"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"description":"The unique identifier of the identity. Only provide a value when updating.","format":"int64"},"identityRules":{"type":["null","array"],"items":{"$ref":"#/components/schemas/ApiPolicyIdentityRuleSaveModel"},"description":"The list of identity rules"},"deployments":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyDeploymentSaveModel"},"description":"The list of deployments associated with the identity"},"isPrivateApplication":{"type":"boolean","description":"Determines if it is a private application"},"issuers":{"description":"The issuers of the identity","$ref":"#/components/schemas/JsonArray"},"name":{"type":"string","description":"The name of the identity"},"throttlingByClaim":{"type":["null","string"],"description":"The throttling by claim for the identity"},"priorityNumber":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"In case of 2 or more matching identities, determines which identity to use. Lower number will be selected.","format":"int32"},"requestLimit":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"description":"The maximum amount of requests. Not null value requires RequestLimitWindowInMinutes to be set.","format":"int32"},"requestLimitWindowInMinutes":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"description":"The request limit window in minutes. Not null value requires RequestLimit to be set.","format":"int32"}}},"ApiPolicyIdentityRuleSaveModel":{"required":["claim"],"type":"object","properties":{"ruleType":{"description":"The type of access rule","$ref":"#/components/schemas/ApiAccessRuleType"},"claim":{"type":"string","description":"The claim associated with the identity rule"},"value":{"type":["null","string"],"description":"The value associated with the identity rule"},"matchType":{"description":"The match type of the identity rule","$ref":"#/components/schemas/IdentityRuleMatchType"}}},"ApiAccessRuleType":{"enum":["Allow","Deny"]},"IdentityRuleMatchType":{"enum":["Exact","Exists","Regex"]},"ApiPolicyDeploymentSaveModel":{"required":["agentGroupName"],"type":"object","properties":{"agentGroupName":{"type":"string","description":"The Agent Group associated with the deployment"}}},"JsonArray":{"type":"array"},"ApiPolicyApiKeyGroupSaveModel":{"required":["apiPolicyApiKeyGroupAssignments","name"],"type":"object","properties":{"apiPolicyApiKeyGroupAssignments":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyApiKeyGroupAssignmentSaveModel"},"description":"The API key group assignments"},"name":{"type":"string","description":"The name of the API key group"},"requestLimit":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"description":"The maximum amount of requests. Not null value requires RequestLimitWindowInMinutes to be set.","format":"int32"},"requestLimitWindowInMinutes":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"description":"The request limit window in minutes. Not null value requires RequestLimit to be set.","format":"int32"}}},"ApiPolicyApiKeyGroupAssignmentSaveModel":{"required":["apiKey"],"type":"object","properties":{"apiKey":{"description":"The API key","$ref":"#/components/schemas/ApiPolicyApiKeySaveModel"}}},"ApiPolicyApiKeySaveModel":{"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"The API key identifier","format":"int64"}}},"ApiPolicyRequestLoggingSaveModel":{"required":["deployments","name","loggingFields"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"description":"The unique identifier of the request logging. Only provide a value when updating.","format":"int64"},"deployments":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyDeploymentSaveModel"},"description":"The list of deployments associated with the request logging"},"name":{"type":"string","description":"The name of the request logging"},"loggingFields":{"description":"The fields logged by request logging","$ref":"#/components/schemas/JsonArray"},"ipLogging":{"description":"IpLoggingType of the request logging","$ref":"#/components/schemas/IpLoggingType"},"requestBodyMaxLengthKb":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Request body maximum length for request logging","format":"int32"},"responseBodyMaxLengthKb":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Response body maximum length for request logging","format":"int32"},"disableLogging":{"type":"boolean","description":"Disable logging for request logging"}}},"IpLoggingType":{"enum":["ClientIP","ClientIPXForwardedForFirst","ClientIPXForwardedForAll","Disable"]},"ParameterLocation":{"enum":["Query","Header","Path","Cookie"]}}}}
```

## The ApiPolicyTargetEndpoint object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ApiPolicyTargetEndpoint":{"required":["apiPolicy","path"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"apiPolicy":{"$ref":"#/components/schemas/ApiPolicy"},"path":{"type":"string"},"method":{"$ref":"#/components/schemas/PolicyEndpointMethod"},"requestLimit":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"},"requestLimitWindowInMinutes":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"}}},"ApiPolicy":{"required":["uniqueIdentifier","name","modifier","apiKeyName","apiKeyLocation"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"uniqueIdentifier":{"type":"string","format":"uuid"},"name":{"type":"string"},"deletedUtc":{"type":["null","string"],"format":"date-time"},"description":{"type":["null","string"]},"modifier":{"type":"string"},"modifiedUtc":{"type":"string","format":"date-time"},"allowPublicAccess":{"type":"boolean"},"apiKeyName":{"type":"string"},"apiKeyLocation":{"$ref":"#/components/schemas/ParameterLocation"},"targetEndpoints":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyTargetEndpoint"}},"identities":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyIdentity"}},"apiKeyGroups":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyApiKeyGroup"}},"requestLoggings":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyRequestLogging"}}}},"ParameterLocation":{"enum":["Query","Header","Path","Cookie"]},"PolicyEndpointMethod":{"enum":["All","Get","Post","Put","Head","Delete","Patch","Options","Connect","Trace"]},"ApiPolicyIdentity":{"required":["apiPolicy"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"apiPolicy":{"$ref":"#/components/schemas/ApiPolicy"},"isPrivateApplication":{"type":"boolean"},"issuersJson":{"type":"string"},"name":{"type":"string"},"throttlingByClaim":{"type":["null","string"]},"priorityNumber":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"identityRules":{"type":["null","array"],"items":{"$ref":"#/components/schemas/ApiPolicyIdentityRule"}},"deployments":{},"requestLimit":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"},"requestLimitWindowInMinutes":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"}}},"ApiPolicyIdentityRule":{"required":["identity"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"identity":{"$ref":"#/components/schemas/ApiPolicyIdentity"},"ruleType":{"$ref":"#/components/schemas/ApiAccessRuleType"},"claim":{"type":"string"},"value":{"type":"string"},"matchType":{"$ref":"#/components/schemas/IdentityRuleMatchType"}}},"ApiAccessRuleType":{"enum":["Allow","Deny"]},"IdentityRuleMatchType":{"enum":["Exact","Exists","Regex"]},"ApiPolicyApiKeyGroup":{"required":["apiPolicy","name"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"apiPolicy":{"$ref":"#/components/schemas/ApiPolicy"},"name":{"type":"string"},"keyGroupAssignments":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyApiKeyGroupAssignment"}},"requestLimit":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"},"requestLimitWindowInMinutes":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"}}},"ApiPolicyApiKeyGroupAssignment":{"required":["apiKey","apiKeyGroup"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"apiKey":{"$ref":"#/components/schemas/ApiKey"},"apiKeyGroup":{"$ref":"#/components/schemas/ApiPolicyApiKeyGroup"}}},"ApiKey":{"required":["name","environment","modifier"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"name":{"type":"string"},"value":{"type":"string","format":"uuid"},"environment":{"type":"string"},"modified":{"type":"string","format":"date-time"},"modifier":{"type":"string"},"groupAssignments":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyApiKeyGroupAssignment"}}}},"ApiPolicyRequestLogging":{"required":["name","apiPolicy","loggingFieldsJson","ipLogging"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"name":{"type":"string"},"apiPolicy":{"$ref":"#/components/schemas/ApiPolicy"},"loggingFieldsJson":{"type":"string"},"ipLogging":{"$ref":"#/components/schemas/IpLoggingType"},"requestBodyMaxLengthKb":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"responseBodyMaxLengthKb":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"disableLogging":{"type":"boolean"},"deployments":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyRequestLoggingDeployment"}}}},"IpLoggingType":{"enum":["ClientIP","ClientIPXForwardedForFirst","ClientIPXForwardedForAll","Disable"]},"ApiPolicyRequestLoggingDeployment":{"required":["apiPolicyRequestLogging","agentGroupName","deployer"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"apiPolicyRequestLogging":{"$ref":"#/components/schemas/ApiPolicyRequestLogging"},"agentGroupName":{"type":"string"},"deployer":{"type":"string"},"deployedUtc":{"type":"string","format":"date-time"}}}}}}
```

## The ApiPolicyTargetEndpointSaveModel object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ApiPolicyTargetEndpointSaveModel":{"required":["path"],"type":"object","properties":{"path":{"type":"string","description":"The path of the target endpoint"},"method":{"description":"The HTTP method of the target endpoint","$ref":"#/components/schemas/PolicyEndpointMethod"},"requestLimit":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"description":"The maximum amount of requests. Not null value requires RequestLimitWindowInMinutes to be set.","format":"int32"},"requestLimitWindowInMinutes":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"description":"The request limit window in minutes. Not null value requires RequestLimit to be set.","format":"int32"}}},"PolicyEndpointMethod":{"enum":["All","Get","Post","Put","Head","Delete","Patch","Options","Connect","Trace"]}}}}
```

## The ApiPolicyTargetEndpointViewModel object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ApiPolicyTargetEndpointViewModel":{"required":["path"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"The unique identifier of the target endpoint","format":"int64"},"path":{"type":"string","description":"The path of the target endpoint"},"method":{"description":"The HTTP method of the target endpoint","$ref":"#/components/schemas/PolicyEndpointMethod"},"requestLimit":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"description":"The maximum amount of requests. Not null value requires RequestLimitWindowInMinutes to be set.","format":"int32"},"requestLimitWindowInMinutes":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"description":"The request limit window in minutes. Not null value requires RequestLimit to be set.","format":"int32"}}},"PolicyEndpointMethod":{"enum":["All","Get","Post","Put","Head","Delete","Patch","Options","Connect","Trace"]}}}}
```

## The ApiPolicyType object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ApiPolicyType":{"enum":["Authentication","Logging",null]}}}}
```

## The ApiPolicyViewModel object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ApiPolicyViewModel":{"required":["name"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"The identifier of the policy","format":"int64"},"uniqueIdentifier":{"type":"string","description":"The globally unique identifier of the policy","format":"uuid"},"modifier":{"type":["null","string"],"description":"The modifier of the policy"},"modifiedUtc":{"type":"string","description":"The timestamp when the policy was last modified","format":"date-time"},"targetEndpoints":{"type":["null","array"],"items":{"$ref":"#/components/schemas/ApiPolicyTargetEndpointViewModel"},"description":"The list of target endpoints associated with the policy"},"identities":{"type":["null","array"],"items":{"$ref":"#/components/schemas/ApiPolicyIdentityViewModel"},"description":"The list of identities associated with the policy"},"apiKeyGroups":{"type":["null","array"],"items":{"$ref":"#/components/schemas/ApiPolicyApiKeyGroupViewModel"},"description":"The list of API key groups associated with the policy"},"publicAccessDeployments":{"type":["null","array"],"items":{"$ref":"#/components/schemas/ApiPolicyDeploymentViewModel"},"description":"The list of deployments connected with public access identity"},"requestLoggingOptions":{"type":["null","array"],"items":{"$ref":"#/components/schemas/ApiPolicyRequestLoggingViewModel"},"description":"The list of request logging options associated with the api policy"},"name":{"type":"string","description":"The name of the policy"},"description":{"type":["null","string"],"description":"The description of the policy"},"tags":{"type":["null","array"],"items":{"type":"string"},"description":"The tags of the policy"},"allowPublicAccess":{"type":"boolean","description":"Determines if public access is allowed"},"apiKeyName":{"type":"string","description":"The name of the API key"},"apiKeyLocation":{"description":"The location of the API key","$ref":"#/components/schemas/ParameterLocation"}}},"ApiPolicyTargetEndpointViewModel":{"required":["path"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"The unique identifier of the target endpoint","format":"int64"},"path":{"type":"string","description":"The path of the target endpoint"},"method":{"description":"The HTTP method of the target endpoint","$ref":"#/components/schemas/PolicyEndpointMethod"},"requestLimit":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"description":"The maximum amount of requests. Not null value requires RequestLimitWindowInMinutes to be set.","format":"int32"},"requestLimitWindowInMinutes":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"description":"The request limit window in minutes. Not null value requires RequestLimit to be set.","format":"int32"}}},"PolicyEndpointMethod":{"enum":["All","Get","Post","Put","Head","Delete","Patch","Options","Connect","Trace"]},"ApiPolicyIdentityViewModel":{"required":["issuers","name"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"The unique identifier of the identity","format":"int64"},"identityRules":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyIdentityRuleViewModel"}},"deployments":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyDeploymentViewModel"},"description":"The list of deployments associated with the identity"},"isPrivateApplication":{"type":"boolean","description":"Determines if it is a private application"},"issuers":{"description":"The issuers of the identity","$ref":"#/components/schemas/JsonArray"},"name":{"type":"string","description":"The name of the identity"},"throttlingByClaim":{"type":["null","string"],"description":"The throttling by claim for the identity"},"priorityNumber":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"In case of 2 or more matching identities, determines which identity to use. Lower number will be selected.","format":"int32"},"requestLimit":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"description":"The maximum amount of requests. Not null value requires RequestLimitWindowInMinutes to be set.","format":"int32"},"requestLimitWindowInMinutes":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"description":"The request limit window in minutes. Not null value requires RequestLimit to be set.","format":"int32"}}},"ApiPolicyIdentityRuleViewModel":{"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"The unique identifier of the identity rule","format":"int64"},"ruleType":{"description":"The type of access rule","$ref":"#/components/schemas/ApiAccessRuleType"},"claim":{"type":["null","string"],"description":"The claim associated with the identity rule"},"value":{"type":["null","string"],"description":"The value associated with the identity rule"},"matchType":{"description":"The match type of the identity rule","$ref":"#/components/schemas/IdentityRuleMatchType"}}},"ApiAccessRuleType":{"enum":["Allow","Deny"]},"IdentityRuleMatchType":{"enum":["Exact","Exists","Regex"]},"ApiPolicyDeploymentViewModel":{"required":["agentGroupName"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"The unique identifier of the deployment","format":"int64"},"deployerUserName":{"type":"string","description":"The username of the deployer"},"deployedUtc":{"type":"string","description":"The timestamp when the deployment occurred","format":"date-time"},"agentGroupName":{"type":"string","description":"The Agent Group associated with the deployment"}}},"JsonArray":{"type":"array"},"ApiPolicyApiKeyGroupViewModel":{"required":["name"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"The unique identifier of the API key group","format":"int64"},"apiPolicyApiKeyGroupAssignments":{"type":["null","array"],"items":{"$ref":"#/components/schemas/ApiPolicyApiKeyGroupAssignmentViewModel"},"description":"The API group assignments"},"name":{"type":"string","description":"The name of the API key group"},"requestLimit":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"description":"The maximum amount of requests. Not null value requires RequestLimitWindowInMinutes to be set.","format":"int32"},"requestLimitWindowInMinutes":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"description":"The request limit window in minutes. Not null value requires RequestLimit to be set.","format":"int32"}}},"ApiPolicyApiKeyGroupAssignmentViewModel":{"required":["apiKey"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"The identifier of the assignment","format":"int64"},"apiKey":{"description":"The API key","$ref":"#/components/schemas/ApiKeyViewModel"}}},"ApiKeyViewModel":{"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"name":{"type":["null","string"]},"environment":{"type":["null","string"]},"value":{"type":"string","format":"uuid"}}},"ApiPolicyRequestLoggingViewModel":{"required":["name","loggingFields"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"The unique identifier of the request logging","format":"int64"},"deployments":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyDeploymentViewModel"},"description":"The list of deployments associated with the request logging"},"name":{"type":"string","description":"The name of the request logging"},"loggingFields":{"description":"The fields logged by request logging","$ref":"#/components/schemas/JsonArray"},"ipLogging":{"description":"IpLoggingType of the request logging","$ref":"#/components/schemas/IpLoggingType"},"requestBodyMaxLengthKb":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Request body maximum length for request logging","format":"int32"},"responseBodyMaxLengthKb":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Response body maximum length for request logging","format":"int32"},"disableLogging":{"type":"boolean","description":"Disable logging for request logging"}}},"IpLoggingType":{"enum":["ClientIP","ClientIPXForwardedForFirst","ClientIPXForwardedForAll","Disable"]},"ParameterLocation":{"enum":["Query","Header","Path","Cookie"]}}}}
```

## The ApiProcessTemplateRequest object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ApiProcessTemplateRequest":{"required":["path","operation"],"type":"object","properties":{"path":{"type":"string","description":"The path of the HTTP endpoint, as specified in the API specification"},"operation":{"type":"string","description":"The operation of the endpoint (e.g. GET)"}}}}}}
```

## The AuditLogDto object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"AuditLogDto":{"required":["user","action","parameters","timestampUtc"],"type":"object","properties":{"user":{"type":"string","description":"User name of the user who performed the action"},"action":{"type":"string","description":"Action performed by the user, in format {Controller}.{Action}"},"parameters":{"description":"Parameters of the action"},"timestampUtc":{"type":"string","description":"Timestamp of the action","format":"date-time"},"description":{"type":["null","string"],"description":"Description of the action"},"source":{"type":"string","description":"Source of the action (API, MCP, System, UI)","default":"UI"},"outcome":{"description":"Outcome of the action (Success or Failure)","$ref":"#/components/schemas/AuditOutcome"}}},"AuditOutcome":{"enum":["Success","Failure"],"default":"Success"}}}}
```

## The AuditOutcome object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"AuditOutcome":{"enum":["Success","Failure"],"default":"Success"}}}}
```

## The CertificatePurpose object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"CertificatePurpose":{"enum":["HttpsServer","ClientAuthentication","ClientCertificateIssuer"]}}}}
```

## The CommentInstancesQueryModel object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"CommentInstancesQueryModel":{"required":["comment","instanceIds"],"type":"object","properties":{"comment":{"type":"string"},"processGuids":{"type":["null","array"],"items":{"type":"string","format":"uuid"}},"instanceIds":{"type":"array","items":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"}}}}}}}
```

## The CreateAcmeAccountRequest object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"CreateAcmeAccountRequest":{"required":["provider"],"type":"object","properties":{"provider":{"type":"string","description":"Provider name (LetsEncrypt, LetsEncryptStaging, ZeroSSL, or Custom)"},"email":{"type":["null","string"],"description":"Optional contact email for the ACME account; a repeated request with the same provider, directory URL and email reuses the account"},"customDirectoryUrl":{"type":["null","string"],"description":"Custom ACME directory URL (required when Provider is Custom)"},"eabKeyId":{"type":["null","string"],"description":"External account binding key identifier (required for providers that require EAB, e.g. ZeroSSL)"},"eabHmacKey":{"type":["null","string"],"description":"External account binding HMAC key (required for providers that require EAB, e.g. ZeroSSL)"},"managedByFrends":{"type":"boolean","description":"Marks the account as managed by Frends operations (requires the FrendsOps role); such accounts back the ACME orders of Frends-operated agent groups","default":false}}}}}}
```

## The CreateAcmeOrderRequest object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"CreateAcmeOrderRequest":{"required":["accountGuid","agentGroupName","domain","challengeType"],"type":"object","properties":{"accountGuid":{"type":"string","description":"ACME account unique identifier to order the certificate under","format":"uuid"},"agentGroupName":{"type":"string","description":"Agent group name that will host the resulting certificate"},"domain":{"type":"string","description":"Domain name to request a certificate for"},"challengeType":{"type":"string","description":"Challenge type to use (dns-01, http-01 or dns-persist-01)"},"certificateName":{"type":["null","string"],"description":"Name of the certificate the order issues (referenced by processes as #cert.<name>; renewals reuse it). Letters, digits, underscores and å/ä/ö, not starting with a digit. Defaults to the domain with every other character replaced by '_'"},"issuerDomainName":{"type":["null","string"],"description":"Issuer domain name for dns-persist-01, overriding the account's provider catalog value (required when the provider has none, e.g. a custom-directory account); ignored for other challenge types"}}}}}}
```

## The CreateProcessFromTemplateRequestBody object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"CreateProcessFromTemplateRequestBody":{"required":["name"],"type":"object","properties":{"ignoreProcessTags":{"type":"boolean","description":"If true the Process will not be created with the predefined tags"},"name":{"type":["null","string"],"description":"Element name"},"description":{"type":["null","string"],"description":"Element description"},"processVariables":{"type":["null","array"],"items":{"$ref":"#/components/schemas/ProcessVariable"}}}},"ProcessVariable":{"type":"object","properties":{"name":{"type":["null","string"]},"value":{"type":["null","string"]},"isSecret":{"type":"boolean"},"mode":{"type":["null","string"]},"description":{"type":["null","string"]}}}}}}
```

## The CreateTemplateFromProcessRequestBody object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"CreateTemplateFromProcessRequestBody":{"required":["processId","name"],"type":"object","properties":{"processId":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Process id","format":"int64"},"guid":{"type":"string","format":"uuid"},"templateMajorVersion":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"description":"Templates major version","format":"int32"},"templateMinorVersion":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"description":"Templates minor version","format":"int32"},"templateTags":{"type":["null","array"],"items":{"type":"string"},"description":"Tags for the Process template"},"processTags":{"type":["null","array"],"items":{"type":"string"},"description":"Predefined tags for Processes created from the template"},"linkProcessToCreatedTemplate":{"type":["null","boolean"],"description":"Link the Process to the created Template"},"name":{"type":["null","string"],"description":"Element name"},"description":{"type":["null","string"],"description":"Element description"},"processVariables":{"type":["null","array"],"items":{"$ref":"#/components/schemas/ProcessVariable"}}}},"ProcessVariable":{"type":"object","properties":{"name":{"type":["null","string"]},"value":{"type":["null","string"]},"isSecret":{"type":"boolean"},"mode":{"type":["null","string"]},"description":{"type":["null","string"]}}}}}}
```

## The DataProtectionHealthStatus object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"DataProtectionHealthStatus":{"enum":["Healthy","Degraded","Unhealthy"]}}}}
```

## The DehydrationState object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"DehydrationState":{"enum":["Dehydrated","Hydrated","DehydrationProcessFailure",null]}}}}
```

## The DtoAcmeAccountGet object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"DtoAcmeAccountGet":{"required":["accountGuid","provider","acmeDirectoryUrl","email","accountUri","hasExternalAccountBinding","managedByFrends","createdUtc"],"type":"object","properties":{"accountGuid":{"type":"string","description":"Account unique identifier","format":"uuid"},"provider":{"type":"string","description":"Provider name"},"acmeDirectoryUrl":{"type":"string","description":"ACME directory URL"},"email":{"type":["null","string"],"description":"Optional contact email for the ACME account"},"accountUri":{"type":["null","string"],"description":"ACME account URI as returned by the ACME server"},"hasExternalAccountBinding":{"type":"boolean","description":"Whether this account was created with external account binding (EAB)"},"managedByFrends":{"type":"boolean","description":"Whether the account is managed by Frends operations (only the FrendsOps role can create or delete it)"},"createdUtc":{"type":"string","description":"Creation timestamp (UTC)","format":"date-time"}}}}}}
```

## The DtoAcmeOrderGet object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"DtoAcmeOrderGet":{"required":["orderGuid","domain","certificateName","challengeType","status","dnsTxtRecordName","dnsTxtValue","lastError","agentGroupName","managedByFrends","certificateGuid","createdUtc","expiresUtc","completedUtc"],"type":"object","properties":{"orderGuid":{"type":"string","description":"Order unique identifier","format":"uuid"},"domain":{"type":"string","description":"Domain name the order is for"},"certificateName":{"type":"string","description":"Name of the certificate the order issues; renewals reuse it"},"challengeType":{"type":"string","description":"Challenge type used for this order"},"status":{"type":"string","description":"Order status, normalized to RFC 8555 lowercase (pending/ready/processing/valid/invalid), or revoked once the issued certificate has been revoked at the CA"},"dnsTxtRecordName":{"type":["null","string"],"description":"DNS TXT record name to create for the dns-01 or dns-persist-01 challenge; null for http-01"},"dnsTxtValue":{"type":["null","string"],"description":"DNS TXT record value to create for the dns-01 or dns-persist-01 challenge; null for http-01"},"lastError":{"type":["null","string"],"description":"Last error encountered while processing the order, if any"},"agentGroupName":{"type":"string","description":"Agent group name the order belongs to"},"managedByFrends":{"type":"boolean","description":"True when the agent group is operated by Frends: only the FrendsOps role can create, validate or finalize the order"},"certificateGuid":{"type":["null","string"],"description":"Certificate unique identifier, set once the order has been finalized","format":"uuid"},"createdUtc":{"type":"string","description":"Creation timestamp (UTC)","format":"date-time"},"expiresUtc":{"type":["null","string"],"description":"Order expiry timestamp (UTC), if known","format":"date-time"},"completedUtc":{"type":["null","string"],"description":"Completion timestamp (UTC), set once finalized","format":"date-time"},"revokedUtc":{"type":["null","string"],"description":"Revocation timestamp (UTC), set once the issued certificate has been revoked at the CA","format":"date-time"},"revocationReason":{"type":["null","string"],"description":"Revocation reason given to the CA, set together with RevokedUtc"}}}}}}
```

## The DtoAgentGet object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"DtoAgentGet":{"type":"object","properties":{"url":{"type":["null","string"],"description":"The hostname or address for the agent. Can either be full URL https://example.org:1234 or hostname subdomain.example.org"},"httpPorts":{"type":["null","array"],"items":{"type":"string"},"description":"List of http ports the Agent listens to. If the Url is a full address (schema://hostname:port?) this can be ignored."},"httpsPorts":{"type":["null","array"],"items":{"type":"string"},"description":"List of https ports the Agent listens to. If the Url is a full address (schema://hostname:port?) this can be ignored."},"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Agent Identifier","format":"int64"},"name":{"type":["null","string"],"description":"Agent name"},"isGateway":{"type":"boolean","description":"If the agent is a Gateway Agent. If true, these Agents are the ones that should primarily be accessible from the internet."},"isCloudAgent":{"type":"boolean","description":"If the agent is a Cloud Agent. If true, the agent is managed by Frends."}}}}}}
```

## The DtoAgentGroupBase object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"DtoAgentGroupBase":{"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Unique identifier for the Agent Group","format":"int64"},"displayName":{"type":["null","string"],"description":"Display name for the Agent Group"}}}}}}
```

## The DtoAgentGroupGet object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"DtoAgentGroupGet":{"type":"object","properties":{"internalName":{"type":["null","string"],"description":"Internal name used by Frends for the Agent Group"},"agents":{"type":["null","array"],"items":{"type":"string"},"description":"The Agents that belong to the Agent Group"},"environment":{"description":"The Environment to which the Agent Group belongs","$ref":"#/components/schemas/DtoEnvironmentBase"},"agentDetails":{"type":["null","array"],"items":{"$ref":"#/components/schemas/DtoAgentGet"},"description":"Details about the Agents that belong to the Agent Group"},"agentRegistrationMode":{"description":"The registration mode that determines the lifecycle policy for agents in this group","$ref":"#/components/schemas/AgentRegistrationMode"},"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Unique identifier for the Agent Group","format":"int64"},"displayName":{"type":["null","string"],"description":"Display name for the Agent Group"}}},"DtoEnvironmentBase":{"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Unique identifier for the Environment","format":"int64"},"displayName":{"type":["null","string"],"description":"Display name for the Environment"}}},"DtoAgentGet":{"type":"object","properties":{"url":{"type":["null","string"],"description":"The hostname or address for the agent. Can either be full URL https://example.org:1234 or hostname subdomain.example.org"},"httpPorts":{"type":["null","array"],"items":{"type":"string"},"description":"List of http ports the Agent listens to. If the Url is a full address (schema://hostname:port?) this can be ignored."},"httpsPorts":{"type":["null","array"],"items":{"type":"string"},"description":"List of https ports the Agent listens to. If the Url is a full address (schema://hostname:port?) this can be ignored."},"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Agent Identifier","format":"int64"},"name":{"type":["null","string"],"description":"Agent name"},"isGateway":{"type":"boolean","description":"If the agent is a Gateway Agent. If true, these Agents are the ones that should primarily be accessible from the internet."},"isCloudAgent":{"type":"boolean","description":"If the agent is a Cloud Agent. If true, the agent is managed by Frends."}}},"AgentRegistrationMode":{"enum":["SelfHosted","Deployment","Cloud","StatefulSet"]}}}}
```

## The DtoAgentStatusGet object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"DtoAgentStatusGet":{"type":"object","properties":{"lastError":{"type":["null","string"],"description":"Date&Time of the last error occurred.","format":"date-time"},"lastUpdate":{"type":["null","string"],"description":"Date&Time of the last agent update occurred.","format":"date-time"},"lastStatus":{"type":["null","string"],"description":"Last known Agent status."},"url":{"type":["null","string"],"description":"The hostname or address for the agent. Can either be full URL https://example.org:1234 or hostname subdomain.example.org"},"httpPorts":{"type":["null","array"],"items":{"type":"string"},"description":"List of http ports the Agent listens to. If the Url is a full address (schema://hostname:port?) this can be ignored."},"httpsPorts":{"type":["null","array"],"items":{"type":"string"},"description":"List of https ports the Agent listens to. If the Url is a full address (schema://hostname:port?) this can be ignored."},"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Agent Identifier","format":"int64"},"name":{"type":["null","string"],"description":"Agent name"},"isGateway":{"type":"boolean","description":"If the agent is a Gateway Agent. If true, these Agents are the ones that should primarily be accessible from the internet."},"isCloudAgent":{"type":"boolean","description":"If the agent is a Cloud Agent. If true, the agent is managed by Frends."}}}}}}
```

## The DtoApiKeyCreate object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"DtoApiKeyCreate":{"type":"object","properties":{"environmentId":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Identifier of the Environment of the API key","format":"int64"},"name":{"type":["null","string"],"description":"Name of the API key"}}}}}}
```

## The DtoApiKeyGet object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"DtoApiKeyGet":{"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Unique identifier for the API key","format":"int64"},"value":{"type":"string","description":"Value of the API key","format":"uuid"},"modified":{"type":"string","description":"The date and time when the API key was last modified","format":"date-time"},"modifier":{"type":["null","string"],"description":"The user who last modified the API key"},"environment":{"description":"Environment of the API key","$ref":"#/components/schemas/DtoEnvironmentBase"},"name":{"type":["null","string"],"description":"Name of the API key"}}},"DtoEnvironmentBase":{"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Unique identifier for the Environment","format":"int64"},"displayName":{"type":["null","string"],"description":"Display name for the Environment"}}}}}}
```

## The DtoApiKeyUpdate object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"DtoApiKeyUpdate":{"type":"object","properties":{"name":{"type":["null","string"],"description":"Name of the API key"}}}}}}
```

## The DtoApiSpecification object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"DtoApiSpecification":{"required":["name"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Unique identifier for the API specification","format":"int64"},"name":{"type":"string","description":"Name of the API specification"},"activeVersion":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Currently active version of the API specification","format":"int32"},"description":{"type":["null","string"],"description":"Description for the API specification"}}}}}}
```

## The DtoCertificateAgentStatus object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"DtoCertificateAgentStatus":{"required":["agentName","status","thumbprint","installedUtc","message","reportedUtc","served"],"type":"object","properties":{"agentName":{"type":"string","description":"Agent name"},"status":{"type":"string","description":"Installed | Failed | Missing | Unknown (reported by the agent for this certificate, or Unknown when agent status information is unavailable), OtherVersion (the agent holds another version of the same name), NotReported (the agent has not reported this certificate)"},"thumbprint":{"type":["null","string"],"description":"Thumbprint the agent reported for the name, when any"},"installedUtc":{"type":["null","string"],"description":"When the agent installed the reported version (UTC)","format":"date-time"},"message":{"type":["null","string"],"description":"Failure or explanation from the agent, when any"},"reportedUtc":{"type":["null","string"],"description":"Timestamp of the heartbeat the status comes from (UTC), when any","format":"date-time"},"served":{"type":"boolean","description":"True when the agent reports serving this certificate on its HTTPS listener"}}}}}}
```

## The DtoCertificateDistributionResult object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"DtoCertificateDistributionResult":{"required":["sentToAgents","sentWithUnknownVersion","outdatedAgents","inactiveAgents"],"type":"object","properties":{"sentToAgents":{"type":"array","items":{"type":"string"},"description":"Agents whose configuration queue received the certificate"},"sentWithUnknownVersion":{"type":"array","items":{"type":"string"},"description":"Agents that received the certificate although their version is unknown"},"outdatedAgents":{"type":"array","items":{"type":"string"},"description":"Agents skipped because their version is too old for certificate distribution"},"inactiveAgents":{"type":"array","items":{"type":"string"},"description":"Agents skipped because they have not sent a heartbeat recently; they receive the certificate on their next synchronization if it is active and their version is 6.4 or later"}}}}}}
```

## The DtoCertificateGet object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"DtoCertificateGet":{"required":["certificateGuid","name","purpose","thumbprint","subject","issuer","notBeforeUtc","notAfterUtc","isActive","hasPrivateKey","source","managedByFrends","agentGroupName","agents","acmeOrderGuid"],"type":"object","properties":{"certificateGuid":{"type":"string","description":"Certificate unique identifier","format":"uuid"},"name":{"type":"string","description":"Stable certificate name; processes and triggers reference it as #cert.<name>. Uploading a new certificate under an existing name rotates it"},"purpose":{"description":"Certificate purpose: HttpsServer (agent HTTPS listener), ClientAuthentication (client certificate with private key) or ClientCertificateIssuer (trusted issuer for HTTP trigger client certificates)","$ref":"#/components/schemas/CertificatePurpose"},"thumbprint":{"type":"string","description":"Certificate thumbprint (SHA-1, uppercase hex)"},"subject":{"type":["null","string"],"description":"Certificate subject"},"issuer":{"type":["null","string"],"description":"Certificate issuer"},"notBeforeUtc":{"type":"string","description":"Validity start (UTC)","format":"date-time"},"notAfterUtc":{"type":"string","description":"Validity end (UTC)","format":"date-time"},"isActive":{"type":"boolean","description":"Whether this certificate is the active version of its name in its agent group"},"hasPrivateKey":{"type":"boolean","description":"Whether the stored certificate carries a private key (always true except for issuer certificates)"},"source":{"type":"string","description":"Certificate source (Manual or ACME)"},"managedByFrends":{"type":"boolean","description":"True when the certificate is an HTTPS certificate of a Frends-operated agent group and can only be changed by Frends operations"},"agentGroupName":{"type":"string","description":"Agent group name"},"agents":{"type":"array","items":{"$ref":"#/components/schemas/DtoCertificateAgentStatus"},"description":"Install status per agent in the certificate's agent group, as reported by agent heartbeats"},"acmeOrderGuid":{"type":["null","string"],"description":"Guid of the ACME order that issued this certificate (null for manually uploaded certificates). A renewal is issued by its own order","format":"uuid"}}},"CertificatePurpose":{"enum":["HttpsServer","ClientAuthentication","ClientCertificateIssuer"]},"DtoCertificateAgentStatus":{"required":["agentName","status","thumbprint","installedUtc","message","reportedUtc","served"],"type":"object","properties":{"agentName":{"type":"string","description":"Agent name"},"status":{"type":"string","description":"Installed | Failed | Missing | Unknown (reported by the agent for this certificate, or Unknown when agent status information is unavailable), OtherVersion (the agent holds another version of the same name), NotReported (the agent has not reported this certificate)"},"thumbprint":{"type":["null","string"],"description":"Thumbprint the agent reported for the name, when any"},"installedUtc":{"type":["null","string"],"description":"When the agent installed the reported version (UTC)","format":"date-time"},"message":{"type":["null","string"],"description":"Failure or explanation from the agent, when any"},"reportedUtc":{"type":["null","string"],"description":"Timestamp of the heartbeat the status comes from (UTC), when any","format":"date-time"},"served":{"type":"boolean","description":"True when the agent reports serving this certificate on its HTTPS listener"}}}}}}
```

## The DtoCertificateUsage object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"DtoCertificateUsage":{"required":["processGuid","processName","version","agentGroupName","environment","kind"],"type":"object","properties":{"processGuid":{"type":"string","description":"Process guid","format":"uuid"},"processName":{"type":"string","description":"Process name"},"version":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Deployed process version","format":"int32"},"agentGroupName":{"type":"string","description":"Agent group the version is deployed to"},"environment":{"type":"string","description":"Environment of the deployment"},"kind":{"type":"string","description":"ProcessReference (a step or trigger uses #cert.<name>), ProcessVariableReference (a process variable of this agent group uses #cert.<name>) or HttpTriggerCertificateAuthentication (an HTTP trigger authenticates callers by client certificate, which relies on the group's issuer certificates)"}}}}}}
```

## The DtoChildSchemaCreate object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"DtoChildSchemaCreate":{"required":["type"],"type":"object","properties":{"type":{"$ref":"#/components/schemas/EnvironmentVariableChildType"},"name":{"type":"string"}}},"EnvironmentVariableChildType":{"enum":["String","Array","Secret","Number","Boolean"]}}}}
```

## The DtoDataProtectionStatus object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"DtoDataProtectionStatus":{"required":["keyProtection","keyEncryptionCertificateThumbprint","keyEncryptionCertificateSource","keyEncryptionCertificateNotAfterUtc","previousKeyEncryptionCertificateThumbprints","keyRingEntries","keyRingCertificateThumbprints","unprotectedKeyRingEntries","certificatePrivateKeys","acmeAccountKeys","acmeExternalAccountBindingKeys","status","problems","warnings"],"type":"object","properties":{"keyProtection":{"type":"string","description":"Configured mode: None (plaintext) or Certificate"},"keyEncryptionCertificateThumbprint":{"type":["null","string"],"description":"Thumbprint of the current key-encryption certificate; null in None mode"},"keyEncryptionCertificateSource":{"type":["null","string"],"description":"Where the current key-encryption certificate was loaded from (store thumbprint, file or Key Vault secret)"},"keyEncryptionCertificateNotAfterUtc":{"type":["null","string"],"description":"Expiry of the current key-encryption certificate (UTC)","format":"date-time"},"previousKeyEncryptionCertificateThumbprints":{"type":"array","items":{"type":"string"},"description":"Thumbprints of the retired key-encryption certificates configured under Previous"},"keyRingEntries":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Number of Data Protection key-ring entries stored in the configuration database","format":"int32"},"keyRingCertificateThumbprints":{"type":"array","items":{"type":"string"},"description":"Thumbprints of every certificate that wraps a key-ring entry; all of them must travel with a database backup"},"unprotectedKeyRingEntries":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Key-ring entries stored without certificate wrapping (must be 0)","format":"int32"},"certificatePrivateKeys":{"description":"CERTIFICATE.CERTIFICATE_PFX rows","$ref":"#/components/schemas/DtoProtectedRowCounts"},"acmeAccountKeys":{"description":"ACME_ACCOUNT.ACCOUNT_KEY_PEM rows","$ref":"#/components/schemas/DtoProtectedRowCounts"},"acmeExternalAccountBindingKeys":{"description":"ACME_ACCOUNT.EAB_HMAC_KEY rows (accounts with an External Account Binding secret)","$ref":"#/components/schemas/DtoProtectedRowCounts"},"status":{"description":"Overall verdict, the same word /health reports: Unhealthy when Problems is non-empty, Degraded when only Warnings is, Healthy otherwise","$ref":"#/components/schemas/DataProtectionHealthStatus"},"problems":{"type":"array","items":{"type":"string"},"description":"Human-readable problems"},"warnings":{"type":"array","items":{"type":"string"},"description":"Conditions that need attention but do not stop the instance from working, such as rows still stored in plaintext in Certificate mode"}}},"DtoProtectedRowCounts":{"required":["encrypted","plaintext"],"type":"object","properties":{"encrypted":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Rows whose stored value carries the encryption marker","format":"int32"},"plaintext":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Rows still stored in plaintext","format":"int32"}}},"DataProtectionHealthStatus":{"enum":["Healthy","Degraded","Unhealthy"]}}}}
```

## The DtoEnvironmentBase object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"DtoEnvironmentBase":{"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Unique identifier for the Environment","format":"int64"},"displayName":{"type":["null","string"],"description":"Display name for the Environment"}}}}}}
```

## The DtoEnvironmentGet object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"DtoEnvironmentGet":{"type":"object","properties":{"agentGroups":{"type":["null","array"],"items":{"$ref":"#/components/schemas/DtoAgentGroupGet"},"description":"The Agent Groups that belong to the Environment"},"internalName":{"type":["null","string"],"description":"Internal name used by Frends for the Environment"},"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Unique identifier for the Environment","format":"int64"},"displayName":{"type":["null","string"],"description":"Display name for the Environment"}}},"DtoAgentGroupGet":{"type":"object","properties":{"internalName":{"type":["null","string"],"description":"Internal name used by Frends for the Agent Group"},"agents":{"type":["null","array"],"items":{"type":"string"},"description":"The Agents that belong to the Agent Group"},"environment":{"description":"The Environment to which the Agent Group belongs","$ref":"#/components/schemas/DtoEnvironmentBase"},"agentDetails":{"type":["null","array"],"items":{"$ref":"#/components/schemas/DtoAgentGet"},"description":"Details about the Agents that belong to the Agent Group"},"agentRegistrationMode":{"description":"The registration mode that determines the lifecycle policy for agents in this group","$ref":"#/components/schemas/AgentRegistrationMode"},"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Unique identifier for the Agent Group","format":"int64"},"displayName":{"type":["null","string"],"description":"Display name for the Agent Group"}}},"DtoEnvironmentBase":{"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Unique identifier for the Environment","format":"int64"},"displayName":{"type":["null","string"],"description":"Display name for the Environment"}}},"DtoAgentGet":{"type":"object","properties":{"url":{"type":["null","string"],"description":"The hostname or address for the agent. Can either be full URL https://example.org:1234 or hostname subdomain.example.org"},"httpPorts":{"type":["null","array"],"items":{"type":"string"},"description":"List of http ports the Agent listens to. If the Url is a full address (schema://hostname:port?) this can be ignored."},"httpsPorts":{"type":["null","array"],"items":{"type":"string"},"description":"List of https ports the Agent listens to. If the Url is a full address (schema://hostname:port?) this can be ignored."},"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Agent Identifier","format":"int64"},"name":{"type":["null","string"],"description":"Agent name"},"isGateway":{"type":"boolean","description":"If the agent is a Gateway Agent. If true, these Agents are the ones that should primarily be accessible from the internet."},"isCloudAgent":{"type":"boolean","description":"If the agent is a Cloud Agent. If true, the agent is managed by Frends."}}},"AgentRegistrationMode":{"enum":["SelfHosted","Deployment","Cloud","StatefulSet"]}}}}
```

## The DtoEnvironmentVariableDescriptionUpdate object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"DtoEnvironmentVariableDescriptionUpdate":{"required":["description"],"type":"object","properties":{"description":{"type":"string"}},"description":"New description."}}}}
```

## The DtoEnvironmentVariableSchemaBase object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"DtoEnvironmentVariableSchemaBase":{"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/EnvironmentVariableType"},"values":{"type":["null","array"],"items":{"$ref":"#/components/schemas/DtoEnvironmentVariableValue"}}}},"EnvironmentVariableType":{"enum":["String","Object","Array","Secret","Number","Boolean"]},"DtoEnvironmentVariableValue":{"type":"object","properties":{"environment":{"$ref":"#/components/schemas/DtoEnvironmentBase"},"value":{"type":"array","items":{"type":"array","items":{"type":"array","items":{}}}},"modifiedUtc":{"type":"string","format":"date-time"},"modifier":{"type":"string"},"version":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"}}},"DtoEnvironmentBase":{"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Unique identifier for the Environment","format":"int64"},"displayName":{"type":["null","string"],"description":"Display name for the Environment"}}}}}}
```

## The DtoEnvironmentVariableSchemaGet object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"DtoEnvironmentVariableSchemaGet":{"type":"object","properties":{"description":{"$ref":"#/components/schemas/JsonElement"},"childSchemas":{"type":"array","items":{"$ref":"#/components/schemas/DtoEnvironmentVariableSchemaBase"}},"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/EnvironmentVariableType"},"values":{"type":["null","array"],"items":{"$ref":"#/components/schemas/DtoEnvironmentVariableValue"}}}},"JsonElement":{},"DtoEnvironmentVariableSchemaBase":{"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/EnvironmentVariableType"},"values":{"type":["null","array"],"items":{"$ref":"#/components/schemas/DtoEnvironmentVariableValue"}}}},"EnvironmentVariableType":{"enum":["String","Object","Array","Secret","Number","Boolean"]},"DtoEnvironmentVariableValue":{"type":"object","properties":{"environment":{"$ref":"#/components/schemas/DtoEnvironmentBase"},"value":{"type":"array","items":{"type":"array","items":{"type":"array","items":{}}}},"modifiedUtc":{"type":"string","format":"date-time"},"modifier":{"type":"string"},"version":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"}}},"DtoEnvironmentBase":{"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Unique identifier for the Environment","format":"int64"},"displayName":{"type":["null","string"],"description":"Display name for the Environment"}}}}}}
```

## The DtoEnvironmentVariableValue object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"DtoEnvironmentVariableValue":{"type":"object","properties":{"environment":{"$ref":"#/components/schemas/DtoEnvironmentBase"},"value":{"type":"array","items":{"type":"array","items":{"type":"array","items":{}}}},"modifiedUtc":{"type":"string","format":"date-time"},"modifier":{"type":"string"},"version":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"}}},"DtoEnvironmentBase":{"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Unique identifier for the Environment","format":"int64"},"displayName":{"type":["null","string"],"description":"Display name for the Environment"}}}}}}
```

## The DtoProcessDeploymentCreate object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"DtoProcessDeploymentCreate":{"required":["agentGroupId","processes","activateTriggers","deploymentDescription"],"type":"object","properties":{"agentGroupId":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"processes":{"maxItems":20,"type":"array","items":{"$ref":"#/components/schemas/ProcessVersionInputModel"}},"activateTriggers":{"type":"boolean","description":"Whether to automatically activate Triggers for Processes on deployment. Default is true."},"deploymentDescription":{"type":"string"}}},"ProcessVersionInputModel":{"type":"object","properties":{"processGuid":{"type":"string","format":"uuid"},"version":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"processVariables":{"type":["null","array"],"items":{"$ref":"#/components/schemas/ProcessVariable"}}}},"ProcessVariable":{"type":"object","properties":{"name":{"type":["null","string"]},"value":{"type":["null","string"]},"isSecret":{"type":"boolean"},"mode":{"type":["null","string"]},"description":{"type":["null","string"]}}}}}}
```

## The DtoProcessDeploymentGet object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"DtoProcessDeploymentGet":{"required":["agentGroup","deploymentId","processId","processName","processGuid","processVersion","processBuildVersion","triggersActive"],"type":"object","properties":{"agentGroup":{"$ref":"#/components/schemas/DtoAgentGroupBase"},"deploymentId":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Unique identifier for the deployment.","format":"int64"},"processId":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Unique identifier for Process version.","format":"int64"},"processName":{"type":["null","string"],"description":"Process name"},"processGuid":{"type":"string","description":"Process unique identifier. This is shared between all versions of the Process.","format":"uuid"},"processVersion":{"type":["null","string"],"description":"Process version in the format X.Y.Z."},"processBuildVersion":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Process build version. This version is incremented by 1 on every successful Process build.","format":"int32"},"deployedAtUtc":{"type":["null","string"],"format":"date-time"},"deployedBy":{"type":["null","string"]},"description":{"type":["null","string"],"description":"Optional description for deployment"},"triggersActive":{"type":"boolean","description":"Are Process Triggers active"}}},"DtoAgentGroupBase":{"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Unique identifier for the Agent Group","format":"int64"},"displayName":{"type":["null","string"],"description":"Display name for the Agent Group"}}}}}}
```

## The DtoProcessGet object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"DtoProcessGet":{"required":["name"],"type":"object","properties":{"bpmn":{"type":"string"},"elementParameters":{"type":"array","items":{"$ref":"#/components/schemas/ElementParameters"}},"manualTrigger":{"type":"array","items":{"type":"array","items":{}}},"obsoleteTasks":{"type":"array","items":{"$ref":"#/components/schemas/TaskSelectionData"}},"draftId":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int64"},"idOfBaseProcessForDraft":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int64"},"isDraft":{"type":"boolean"},"isSubprocess":{"type":"boolean"},"triggerData":{"type":["null","array"],"items":{"type":"array","items":{}}},"majorVersion":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"minorVersion":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"activateIfNew":{"type":"boolean"},"frendsVersion":{"type":["null","string"]},"ignoreDependencyConflicts":{"type":["null","boolean"]},"documentationMarkdown":{"type":["null","string"]},"targetFramework":{"type":"string"},"apiSpecId":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int64"},"isForMonitoringRule":{"type":"boolean"},"validationOnly":{"type":"boolean"},"cancellationDisabled":{"type":"boolean"},"preserveReferencesAtCheckpoint":{"type":"boolean"},"processVariables":{"type":["null","array"],"items":{"$ref":"#/components/schemas/ProcessVariable"}},"processTemplateId":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int64"},"processTemplateDeviated":{"type":["null","string"],"format":"date-time"},"nextProcessTemplate":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/ProcessTemplate"}]},"performAdditionalSyntaxValidation":{"type":"boolean"},"isDeleted":{"type":"boolean"},"version":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"uniqueIdentifier":{"type":"string","format":"uuid"},"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"name":{"type":"string"},"modified":{"type":"string","format":"date-time"},"modifier":{"type":["null","string"]},"description":{"type":["null","string"]},"isNotLatestVersion":{"type":"boolean"},"changeDescription":{"type":["null","string"]}}},"ElementParameters":{"type":"object","properties":{"id":{"type":["null","string"]},"type":{"$ref":"#/components/schemas/ElementType"},"parameters":{"type":["null","object"],"additionalProperties":{"type":"array","items":{"type":"array","items":{}}}},"selectedTypeId":{"type":["null","string"]},"promoteResultAs":{"type":["null","string"]},"name":{"type":["null","string"]},"description":{"type":["null","string"]},"isDefault":{"type":["null","boolean"]},"shouldRetry":{"type":["null","boolean"]},"maxRetryCount":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"},"shouldNotLogResult":{"type":["null","boolean"]},"shouldDispose":{"type":["null","boolean"]}}},"ElementType":{"enum":["Start","Task","Decision","SequenceFlow","ConditionBranch","Return","Throw","CallActivity","SubProcess","ParallelForeach","SequentialForeach","While","Expression","SubProcessStartNode","Catch","InclusiveGateway","InclusiveDecisionBranch","IntermediateReturn","GlobalErrorHandler","TestTask","SharedState","Dmn","DataObjectReference","DataStoreReference","HydrationPoint","ScheduledRehydration","SignalRehydration","NativeAi","Vdm"]},"TaskSelectionData":{"type":"object","properties":{"uri":{"type":"string"},"argumentsJson":{"type":["null","string"]},"returnType":{"type":["null","string"]},"name":{"type":"string"},"displayName":{"type":["null","string"]},"packageName":{"type":"string"},"description":{"type":["null","string"]},"isNotLatestVersion":{"type":"boolean"},"isStandard":{"type":"boolean"},"isDotNet":{"type":"boolean"}}},"ProcessVariable":{"type":"object","properties":{"name":{"type":["null","string"]},"value":{"type":["null","string"]},"isSecret":{"type":"boolean"},"mode":{"type":["null","string"]},"description":{"type":["null","string"]}}},"ProcessTemplate":{"required":["uniqueIdentifier","isListed","version","isDeleted","majorVersion","minorVersion","name","modifier","modified","targetFramework","frendsVersion","isSubProcess","staticRequiredEnvironmentVariablesJson","staticRequiredCertificatesJson","allowedMcpToolsJson"],"type":"object","properties":{"uniqueIdentifier":{"type":"string","format":"uuid"},"isListed":{"type":"boolean"},"version":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"isDeleted":{"type":"boolean"},"processVariablesJson":{"maxLength":2147483647,"type":["null","string"]},"processTags":{"maxLength":2147483647,"type":["null","string"]},"documentation":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/ProcessDocumentation"}]},"getVersion":{"pattern":"^\\d+(\\.\\d+){1,3}$","type":["null","string"]},"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"majorVersion":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"minorVersion":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"name":{"maxLength":512,"minLength":0,"type":"string"},"modifier":{"maxLength":256,"minLength":0,"type":"string"},"modified":{"type":"string","format":"date-time"},"targetFramework":{"maxLength":32,"minLength":0,"type":"string"},"frendsVersion":{"maxLength":64,"minLength":0,"type":"string"},"isSubProcess":{"type":"boolean"},"staticRequiredEnvironmentVariablesJson":{"maxLength":2147483647,"type":"string"},"staticRequiredCertificatesJson":{"maxLength":2147483647,"type":"string"},"description":{"maxLength":2147483647,"minLength":0,"type":["null","string"]},"changeDescription":{"maxLength":2147483647,"minLength":0,"type":["null","string"]},"bpmn":{"maxLength":2147483647,"minLength":0,"type":["null","string"]},"isForMonitoringRule":{"type":["null","boolean"]},"cancellationDisabled":{"type":["null","boolean"]},"elementParameters":{"maxLength":2147483647,"minLength":0,"type":["null","string"]},"promotedResultVariablesJson":{"maxLength":2147483647,"minLength":0,"type":["null","string"]},"usedSubprocessesJson":{"maxLength":2147483647,"minLength":0,"type":["null","string"]},"usedTasksJson":{"maxLength":2147483647,"minLength":0,"type":["null","string"]},"triggersJson":{"maxLength":2147483647,"minLength":0,"type":["null","string"]},"manualTriggerJson":{"maxLength":2147483647,"minLength":0,"type":["null","string"]},"allowedMcpToolsJson":{"maxLength":2147483647,"minLength":0,"type":"string"},"preserveReferencesAtCheckpoint":{"type":"boolean"}}},"ProcessDocumentation":{"required":["uniqueIdentifier","documentationMarkdown","modifier","majorVersion","minorVersion"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"uniqueIdentifier":{"type":"string","format":"uuid"},"documentationMarkdown":{"maxLength":2147483647,"type":"string"},"modifier":{"maxLength":256,"type":"string"},"majorVersion":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"minorVersion":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"modifiedUtc":{"type":"string","format":"date-time"}}}}}}
```

## The DtoProcessInstanceGet object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"DtoProcessInstanceGet":{"type":"object","properties":{"nextContinuationToken":{"type":["null","string"],"description":"ContinuationToken to be used in the next query. Warning! If any filters except continuationToken are changed between requests the results will be invalid. If the token is null there are no more results to fetch with the selected filters."},"nextLink":{"oneOf":[{"type":"null"},{"description":"Link for next set of results with the same query filters","$ref":"#/components/schemas/LinkModel"}]},"data":{"type":["null","array"],"items":{"$ref":"#/components/schemas/ProcessInstanceViewModel"},"description":"Response data"}}},"LinkModel":{"required":["uri","method"],"type":"object","properties":{"uri":{"type":"string","format":"uri"},"method":{"type":"string"}}},"ProcessInstanceViewModel":{"type":"object","properties":{"triggerName":{"type":["null","string"]},"environmentName":{"type":["null","string"]},"agentGroupName":{"type":["null","string"]},"agentName":{"type":["null","string"]},"processGuid":{"type":"string","format":"uuid"},"parentName":{"type":["null","string"]},"triggerRequest":{"type":["null","array"],"items":{"type":"array","items":{"type":"array","items":{}}}},"triggerResponses":{"type":["null","array"],"items":{"type":"array","items":{}}},"promotedColumns":{"type":["null","array"],"items":{"$ref":"#/components/schemas/PromotedColumn"}},"dehydrationState":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/DehydrationState"}]},"correlationId":{"type":["null","string"]},"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"parentId":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int64"},"processId":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"rootProcessId":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"},"processVersion":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"state":{"$ref":"#/components/schemas/ExecutionState"},"startTimeUtc":{"type":["null","string"],"format":"date-time"},"endTimeUtc":{"type":["null","string"],"format":"date-time"},"utcDate":{"type":"string","format":"date-time"},"utcHour":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int16"},"executionId":{"type":"string","format":"uuid"},"triggerId":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"},"agentId":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"environmentId":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"agentGroupId":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"exception":{"type":["null","string"]},"userName":{"type":["null","string"]},"hasLoggedSteps":{"type":["null","boolean"]},"acknowledgedUtc":{"type":["null","string"],"format":"date-time"},"commentJson":{"type":["null","string"]},"comment":{"type":"string"},"promotedData":{"type":["null","array"],"items":{"$ref":"#/components/schemas/ProcessPromotedData"}}}},"PromotedColumn":{"type":"object","properties":{"name":{"type":["null","string"]},"value":{"type":["null","array"],"items":{"type":"array","items":{}}}}},"DehydrationState":{"enum":["Dehydrated","Hydrated","DehydrationProcessFailure",null]},"ExecutionState":{"enum":["Ok","Waiting","Launched","Starting","Started","Canceled","CanceledByTerminate","FinishedAsZombie","TerminatedByUser","ActionSkipped","Failed","Exception","Finished"]},"ProcessPromotedData":{"required":["environmentName","promotedVariableName","promotedValueJson"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"processExecutionId":{"type":"string","format":"uuid"},"timeStamp":{"type":"string","format":"date-time"},"environmentName":{"type":"string"},"promotedVariableName":{"type":"string"},"promotedValueJson":{"type":"string"}}}}}}
```

## The DtoProcessListGet object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"DtoProcessListGet":{"required":["name"],"type":"object","properties":{"links":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/ProcessLinkModel"}]},"bpmn":{"type":"string"},"elementParameters":{"type":"array","items":{"$ref":"#/components/schemas/ElementParameters"}},"manualTrigger":{"type":"array","items":{"type":"array","items":{}}},"obsoleteTasks":{"type":"array","items":{"$ref":"#/components/schemas/TaskSelectionData"}},"draftId":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int64"},"idOfBaseProcessForDraft":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int64"},"isDraft":{"type":"boolean"},"isSubprocess":{"type":"boolean"},"triggerData":{"type":["null","array"],"items":{"type":"array","items":{}}},"majorVersion":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"minorVersion":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"activateIfNew":{"type":"boolean"},"frendsVersion":{"type":["null","string"]},"ignoreDependencyConflicts":{"type":["null","boolean"]},"documentationMarkdown":{"type":["null","string"]},"targetFramework":{"type":"string"},"apiSpecId":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int64"},"isForMonitoringRule":{"type":"boolean"},"validationOnly":{"type":"boolean"},"cancellationDisabled":{"type":"boolean"},"preserveReferencesAtCheckpoint":{"type":"boolean"},"processVariables":{"type":["null","array"],"items":{"$ref":"#/components/schemas/ProcessVariable"}},"processTemplateId":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int64"},"processTemplateDeviated":{"type":["null","string"],"format":"date-time"},"nextProcessTemplate":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/ProcessTemplate"}]},"performAdditionalSyntaxValidation":{"type":"boolean"},"isDeleted":{"type":"boolean"},"version":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"uniqueIdentifier":{"type":"string","format":"uuid"},"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"name":{"type":"string"},"modified":{"type":"string","format":"date-time"},"modifier":{"type":["null","string"]},"description":{"type":["null","string"]},"isNotLatestVersion":{"type":"boolean"},"changeDescription":{"type":["null","string"]}}},"ProcessLinkModel":{"type":"object","properties":{"deployments":{"description":"Get all deployments for all versions of this Process","$ref":"#/components/schemas/LinkModel"},"delete":{"description":"Delete the process","$ref":"#/components/schemas/LinkModel"}}},"LinkModel":{"required":["uri","method"],"type":"object","properties":{"uri":{"type":"string","format":"uri"},"method":{"type":"string"}}},"ElementParameters":{"type":"object","properties":{"id":{"type":["null","string"]},"type":{"$ref":"#/components/schemas/ElementType"},"parameters":{"type":["null","object"],"additionalProperties":{"type":"array","items":{"type":"array","items":{}}}},"selectedTypeId":{"type":["null","string"]},"promoteResultAs":{"type":["null","string"]},"name":{"type":["null","string"]},"description":{"type":["null","string"]},"isDefault":{"type":["null","boolean"]},"shouldRetry":{"type":["null","boolean"]},"maxRetryCount":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"},"shouldNotLogResult":{"type":["null","boolean"]},"shouldDispose":{"type":["null","boolean"]}}},"ElementType":{"enum":["Start","Task","Decision","SequenceFlow","ConditionBranch","Return","Throw","CallActivity","SubProcess","ParallelForeach","SequentialForeach","While","Expression","SubProcessStartNode","Catch","InclusiveGateway","InclusiveDecisionBranch","IntermediateReturn","GlobalErrorHandler","TestTask","SharedState","Dmn","DataObjectReference","DataStoreReference","HydrationPoint","ScheduledRehydration","SignalRehydration","NativeAi","Vdm"]},"TaskSelectionData":{"type":"object","properties":{"uri":{"type":"string"},"argumentsJson":{"type":["null","string"]},"returnType":{"type":["null","string"]},"name":{"type":"string"},"displayName":{"type":["null","string"]},"packageName":{"type":"string"},"description":{"type":["null","string"]},"isNotLatestVersion":{"type":"boolean"},"isStandard":{"type":"boolean"},"isDotNet":{"type":"boolean"}}},"ProcessVariable":{"type":"object","properties":{"name":{"type":["null","string"]},"value":{"type":["null","string"]},"isSecret":{"type":"boolean"},"mode":{"type":["null","string"]},"description":{"type":["null","string"]}}},"ProcessTemplate":{"required":["uniqueIdentifier","isListed","version","isDeleted","majorVersion","minorVersion","name","modifier","modified","targetFramework","frendsVersion","isSubProcess","staticRequiredEnvironmentVariablesJson","staticRequiredCertificatesJson","allowedMcpToolsJson"],"type":"object","properties":{"uniqueIdentifier":{"type":"string","format":"uuid"},"isListed":{"type":"boolean"},"version":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"isDeleted":{"type":"boolean"},"processVariablesJson":{"maxLength":2147483647,"type":["null","string"]},"processTags":{"maxLength":2147483647,"type":["null","string"]},"documentation":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/ProcessDocumentation"}]},"getVersion":{"pattern":"^\\d+(\\.\\d+){1,3}$","type":["null","string"]},"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"majorVersion":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"minorVersion":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"name":{"maxLength":512,"minLength":0,"type":"string"},"modifier":{"maxLength":256,"minLength":0,"type":"string"},"modified":{"type":"string","format":"date-time"},"targetFramework":{"maxLength":32,"minLength":0,"type":"string"},"frendsVersion":{"maxLength":64,"minLength":0,"type":"string"},"isSubProcess":{"type":"boolean"},"staticRequiredEnvironmentVariablesJson":{"maxLength":2147483647,"type":"string"},"staticRequiredCertificatesJson":{"maxLength":2147483647,"type":"string"},"description":{"maxLength":2147483647,"minLength":0,"type":["null","string"]},"changeDescription":{"maxLength":2147483647,"minLength":0,"type":["null","string"]},"bpmn":{"maxLength":2147483647,"minLength":0,"type":["null","string"]},"isForMonitoringRule":{"type":["null","boolean"]},"cancellationDisabled":{"type":["null","boolean"]},"elementParameters":{"maxLength":2147483647,"minLength":0,"type":["null","string"]},"promotedResultVariablesJson":{"maxLength":2147483647,"minLength":0,"type":["null","string"]},"usedSubprocessesJson":{"maxLength":2147483647,"minLength":0,"type":["null","string"]},"usedTasksJson":{"maxLength":2147483647,"minLength":0,"type":["null","string"]},"triggersJson":{"maxLength":2147483647,"minLength":0,"type":["null","string"]},"manualTriggerJson":{"maxLength":2147483647,"minLength":0,"type":["null","string"]},"allowedMcpToolsJson":{"maxLength":2147483647,"minLength":0,"type":"string"},"preserveReferencesAtCheckpoint":{"type":"boolean"}}},"ProcessDocumentation":{"required":["uniqueIdentifier","documentationMarkdown","modifier","majorVersion","minorVersion"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"uniqueIdentifier":{"type":"string","format":"uuid"},"documentationMarkdown":{"maxLength":2147483647,"type":"string"},"modifier":{"maxLength":256,"type":"string"},"majorVersion":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"minorVersion":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"modifiedUtc":{"type":"string","format":"date-time"}}}}}}
```

## The DtoProtectedRowCounts object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"DtoProtectedRowCounts":{"required":["encrypted","plaintext"],"type":"object","properties":{"encrypted":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Rows whose stored value carries the encryption marker","format":"int32"},"plaintext":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Rows still stored in plaintext","format":"int32"}}}}}}
```

## The DtoRootSchemaCreate object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"DtoRootSchemaCreate":{"type":"object","properties":{"name":{"type":"string"}}}}}}
```

## The ElementParameters object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ElementParameters":{"type":"object","properties":{"id":{"type":["null","string"]},"type":{"$ref":"#/components/schemas/ElementType"},"parameters":{"type":["null","object"],"additionalProperties":{"type":"array","items":{"type":"array","items":{}}}},"selectedTypeId":{"type":["null","string"]},"promoteResultAs":{"type":["null","string"]},"name":{"type":["null","string"]},"description":{"type":["null","string"]},"isDefault":{"type":["null","boolean"]},"shouldRetry":{"type":["null","boolean"]},"maxRetryCount":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"},"shouldNotLogResult":{"type":["null","boolean"]},"shouldDispose":{"type":["null","boolean"]}}},"ElementType":{"enum":["Start","Task","Decision","SequenceFlow","ConditionBranch","Return","Throw","CallActivity","SubProcess","ParallelForeach","SequentialForeach","While","Expression","SubProcessStartNode","Catch","InclusiveGateway","InclusiveDecisionBranch","IntermediateReturn","GlobalErrorHandler","TestTask","SharedState","Dmn","DataObjectReference","DataStoreReference","HydrationPoint","ScheduledRehydration","SignalRehydration","NativeAi","Vdm"]}}}}
```

## The ElementType object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ElementType":{"enum":["Start","Task","Decision","SequenceFlow","ConditionBranch","Return","Throw","CallActivity","SubProcess","ParallelForeach","SequentialForeach","While","Expression","SubProcessStartNode","Catch","InclusiveGateway","InclusiveDecisionBranch","IntermediateReturn","GlobalErrorHandler","TestTask","SharedState","Dmn","DataObjectReference","DataStoreReference","HydrationPoint","ScheduledRehydration","SignalRehydration","NativeAi","Vdm"]}}}}
```

## The EntityTagHeaderValue object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"EntityTagHeaderValue":{"type":"object","properties":{"tag":{"$ref":"#/components/schemas/StringSegment"},"isWeak":{"type":"boolean"}}},"StringSegment":{"type":"object","properties":{"buffer":{"type":["null","string"]},"offset":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"length":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"value":{"type":["null","string"]},"hasValue":{"type":"boolean"}}}}}}
```

## The EnvironmentVariableChildType object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"EnvironmentVariableChildType":{"enum":["String","Array","Secret","Number","Boolean"]}}}}
```

## The EnvironmentVariableType object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"EnvironmentVariableType":{"enum":["String","Object","Array","Secret","Number","Boolean"]}}}}
```

## The ExecutionState object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ExecutionState":{"enum":["Ok","Waiting","Launched","Starting","Started","Canceled","CanceledByTerminate","FinishedAsZombie","TerminatedByUser","ActionSkipped","Failed","Exception","Finished"]}}}}
```

## The FileContentResult object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"FileContentResult":{"type":"object","properties":{"fileContents":{"type":"string","format":"byte"},"contentType":{"type":["null","string"]},"fileDownloadName":{"type":["null","string"]},"lastModified":{"type":["null","string"],"format":"date-time"},"entityTag":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/EntityTagHeaderValue"}]},"enableRangeProcessing":{"type":"boolean"}}},"EntityTagHeaderValue":{"type":"object","properties":{"tag":{"$ref":"#/components/schemas/StringSegment"},"isWeak":{"type":"boolean"}}},"StringSegment":{"type":"object","properties":{"buffer":{"type":["null","string"]},"offset":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"length":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"value":{"type":["null","string"]},"hasValue":{"type":"boolean"}}}}}}
```

## The FileResult object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"FileResult":{"type":"object","properties":{"contentType":{"type":["null","string"]},"fileDownloadName":{"type":["null","string"]},"lastModified":{"type":["null","string"],"format":"date-time"},"entityTag":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/EntityTagHeaderValue"}]},"enableRangeProcessing":{"type":"boolean"}}},"EntityTagHeaderValue":{"type":"object","properties":{"tag":{"$ref":"#/components/schemas/StringSegment"},"isWeak":{"type":"boolean"}}},"StringSegment":{"type":"object","properties":{"buffer":{"type":["null","string"]},"offset":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"length":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"value":{"type":["null","string"]},"hasValue":{"type":"boolean"}}}}}}
```

## The FilterMode object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"FilterMode":{"enum":["Or","And"]}}}}
```

## The FindEffectiveApiPolicyViewModel object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"FindEffectiveApiPolicyViewModel":{"required":["policy","endpoint"],"type":"object","properties":{"policy":{"$ref":"#/components/schemas/ApiPolicy"},"endpoint":{"$ref":"#/components/schemas/ApiPolicyTargetEndpoint"}}},"ApiPolicy":{"required":["uniqueIdentifier","name","modifier","apiKeyName","apiKeyLocation"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"uniqueIdentifier":{"type":"string","format":"uuid"},"name":{"type":"string"},"deletedUtc":{"type":["null","string"],"format":"date-time"},"description":{"type":["null","string"]},"modifier":{"type":"string"},"modifiedUtc":{"type":"string","format":"date-time"},"allowPublicAccess":{"type":"boolean"},"apiKeyName":{"type":"string"},"apiKeyLocation":{"$ref":"#/components/schemas/ParameterLocation"},"targetEndpoints":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyTargetEndpoint"}},"identities":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyIdentity"}},"apiKeyGroups":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyApiKeyGroup"}},"requestLoggings":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyRequestLogging"}}}},"ParameterLocation":{"enum":["Query","Header","Path","Cookie"]},"ApiPolicyTargetEndpoint":{"required":["apiPolicy","path"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"apiPolicy":{"$ref":"#/components/schemas/ApiPolicy"},"path":{"type":"string"},"method":{"$ref":"#/components/schemas/PolicyEndpointMethod"},"requestLimit":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"},"requestLimitWindowInMinutes":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"}}},"PolicyEndpointMethod":{"enum":["All","Get","Post","Put","Head","Delete","Patch","Options","Connect","Trace"]},"ApiPolicyIdentity":{"required":["apiPolicy"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"apiPolicy":{"$ref":"#/components/schemas/ApiPolicy"},"isPrivateApplication":{"type":"boolean"},"issuersJson":{"type":"string"},"name":{"type":"string"},"throttlingByClaim":{"type":["null","string"]},"priorityNumber":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"identityRules":{"type":["null","array"],"items":{"$ref":"#/components/schemas/ApiPolicyIdentityRule"}},"deployments":{},"requestLimit":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"},"requestLimitWindowInMinutes":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"}}},"ApiPolicyIdentityRule":{"required":["identity"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"identity":{"$ref":"#/components/schemas/ApiPolicyIdentity"},"ruleType":{"$ref":"#/components/schemas/ApiAccessRuleType"},"claim":{"type":"string"},"value":{"type":"string"},"matchType":{"$ref":"#/components/schemas/IdentityRuleMatchType"}}},"ApiAccessRuleType":{"enum":["Allow","Deny"]},"IdentityRuleMatchType":{"enum":["Exact","Exists","Regex"]},"ApiPolicyApiKeyGroup":{"required":["apiPolicy","name"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"apiPolicy":{"$ref":"#/components/schemas/ApiPolicy"},"name":{"type":"string"},"keyGroupAssignments":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyApiKeyGroupAssignment"}},"requestLimit":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"},"requestLimitWindowInMinutes":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"}}},"ApiPolicyApiKeyGroupAssignment":{"required":["apiKey","apiKeyGroup"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"apiKey":{"$ref":"#/components/schemas/ApiKey"},"apiKeyGroup":{"$ref":"#/components/schemas/ApiPolicyApiKeyGroup"}}},"ApiKey":{"required":["name","environment","modifier"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"name":{"type":"string"},"value":{"type":"string","format":"uuid"},"environment":{"type":"string"},"modified":{"type":"string","format":"date-time"},"modifier":{"type":"string"},"groupAssignments":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyApiKeyGroupAssignment"}}}},"ApiPolicyRequestLogging":{"required":["name","apiPolicy","loggingFieldsJson","ipLogging"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"name":{"type":"string"},"apiPolicy":{"$ref":"#/components/schemas/ApiPolicy"},"loggingFieldsJson":{"type":"string"},"ipLogging":{"$ref":"#/components/schemas/IpLoggingType"},"requestBodyMaxLengthKb":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"responseBodyMaxLengthKb":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"disableLogging":{"type":"boolean"},"deployments":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyRequestLoggingDeployment"}}}},"IpLoggingType":{"enum":["ClientIP","ClientIPXForwardedForFirst","ClientIPXForwardedForAll","Disable"]},"ApiPolicyRequestLoggingDeployment":{"required":["apiPolicyRequestLogging","agentGroupName","deployer"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"apiPolicyRequestLogging":{"$ref":"#/components/schemas/ApiPolicyRequestLogging"},"agentGroupName":{"type":"string"},"deployer":{"type":"string"},"deployedUtc":{"type":"string","format":"date-time"}}}}}}
```

## The IdentityRuleMatchType object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"IdentityRuleMatchType":{"enum":["Exact","Exists","Regex"]}}}}
```

## The IFormFile object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"IFormFile":{"type":"string","format":"binary"}}}}
```

## The ImportResult object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ImportResult":{"required":["name","resourceLocation"],"type":"object","properties":{"name":{"type":"string"},"elementIdentifier":{"type":"string","format":"uuid"},"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"resourceLocation":{"type":"string","format":"uri"},"version":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"}}}}}}
```

## The IpLoggingType object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"IpLoggingType":{"enum":["ClientIP","ClientIPXForwardedForFirst","ClientIPXForwardedForAll","Disable"]}}}}
```

## The JsonArray object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"JsonArray":{"type":"array"}}}}
```

## The JsonElement object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"JsonElement":{}}}}
```

## The JsonObject object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"JsonObject":{"type":"object"}}}}
```

## The LinkModel object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"LinkModel":{"required":["uri","method"],"type":"object","properties":{"uri":{"type":"string","format":"uri"},"method":{"type":"string"}}}}}}
```

## The ModifyApplicationModel object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ModifyApplicationModel":{"required":["name","description","defaultTokenLifetimeDays","customTokenClaims","tags"],"type":"object","properties":{"name":{"type":"string","description":"Name of the application"},"description":{"type":["null","string"],"description":"Description of the application"},"defaultTokenLifetimeDays":{"maximum":730,"minimum":1,"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Default token lifetime in days","format":"int32"},"customTokenClaims":{"description":"Custom token claims","$ref":"#/components/schemas/JsonObject"},"tags":{"type":"array","items":{"type":"string"},"description":"Tags for the application"}}},"JsonObject":{"type":"object"}}}}
```

## The PagedResponseOfAgentEventViewModel object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"PagedResponseOfAgentEventViewModel":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AgentEventViewModel"},"description":"Response data"},"paging":{"description":"Response paging","$ref":"#/components/schemas/PagingModel"}}},"AgentEventViewModel":{"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"eventId":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"level":{"type":"string"},"utcTimestamp":{"type":"string","format":"date-time"},"category":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"source":{"type":"string"},"message":{"type":"string"}}},"PagingModel":{"type":"object","properties":{"currentPage":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Current page","format":"int32"},"pageSize":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Number of entries per page","format":"int32"},"totalCount":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Total number of entries","format":"int32"},"firstPage":{"type":["null","string"],"description":"Url of the first page","format":"uri"},"lastPage":{"type":["null","string"],"description":"Url of the last page","format":"uri"},"nextPage":{"type":["null","string"],"description":"Url of the next page","format":"uri"},"previousPage":{"type":["null","string"],"description":"Url of the previous page","format":"uri"}}}}}}
```

## The PagedResponseOfAuditLogDto object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"PagedResponseOfAuditLogDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AuditLogDto"},"description":"Response data"},"paging":{"description":"Response paging","$ref":"#/components/schemas/PagingModel"}}},"AuditLogDto":{"required":["user","action","parameters","timestampUtc"],"type":"object","properties":{"user":{"type":"string","description":"User name of the user who performed the action"},"action":{"type":"string","description":"Action performed by the user, in format {Controller}.{Action}"},"parameters":{"description":"Parameters of the action"},"timestampUtc":{"type":"string","description":"Timestamp of the action","format":"date-time"},"description":{"type":["null","string"],"description":"Description of the action"},"source":{"type":"string","description":"Source of the action (API, MCP, System, UI)","default":"UI"},"outcome":{"description":"Outcome of the action (Success or Failure)","$ref":"#/components/schemas/AuditOutcome"}}},"AuditOutcome":{"enum":["Success","Failure"],"default":"Success"},"PagingModel":{"type":"object","properties":{"currentPage":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Current page","format":"int32"},"pageSize":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Number of entries per page","format":"int32"},"totalCount":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Total number of entries","format":"int32"},"firstPage":{"type":["null","string"],"description":"Url of the first page","format":"uri"},"lastPage":{"type":["null","string"],"description":"Url of the last page","format":"uri"},"nextPage":{"type":["null","string"],"description":"Url of the next page","format":"uri"},"previousPage":{"type":["null","string"],"description":"Url of the previous page","format":"uri"}}}}}}
```

## The PagedResponseOfDtoApiSpecification object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"PagedResponseOfDtoApiSpecification":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/DtoApiSpecification"},"description":"Response data"},"paging":{"description":"Response paging","$ref":"#/components/schemas/PagingModel"}}},"DtoApiSpecification":{"required":["name"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Unique identifier for the API specification","format":"int64"},"name":{"type":"string","description":"Name of the API specification"},"activeVersion":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Currently active version of the API specification","format":"int32"},"description":{"type":["null","string"],"description":"Description for the API specification"}}},"PagingModel":{"type":"object","properties":{"currentPage":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Current page","format":"int32"},"pageSize":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Number of entries per page","format":"int32"},"totalCount":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Total number of entries","format":"int32"},"firstPage":{"type":["null","string"],"description":"Url of the first page","format":"uri"},"lastPage":{"type":["null","string"],"description":"Url of the last page","format":"uri"},"nextPage":{"type":["null","string"],"description":"Url of the next page","format":"uri"},"previousPage":{"type":["null","string"],"description":"Url of the previous page","format":"uri"}}}}}}
```

## The PagedResponseOfDtoEnvironmentVariableSchemaGet object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"PagedResponseOfDtoEnvironmentVariableSchemaGet":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/DtoEnvironmentVariableSchemaGet"},"description":"Response data"},"paging":{"description":"Response paging","$ref":"#/components/schemas/PagingModel"}}},"DtoEnvironmentVariableSchemaGet":{"type":"object","properties":{"description":{"$ref":"#/components/schemas/JsonElement"},"childSchemas":{"type":"array","items":{"$ref":"#/components/schemas/DtoEnvironmentVariableSchemaBase"}},"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/EnvironmentVariableType"},"values":{"type":["null","array"],"items":{"$ref":"#/components/schemas/DtoEnvironmentVariableValue"}}}},"JsonElement":{},"DtoEnvironmentVariableSchemaBase":{"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/EnvironmentVariableType"},"values":{"type":["null","array"],"items":{"$ref":"#/components/schemas/DtoEnvironmentVariableValue"}}}},"EnvironmentVariableType":{"enum":["String","Object","Array","Secret","Number","Boolean"]},"DtoEnvironmentVariableValue":{"type":"object","properties":{"environment":{"$ref":"#/components/schemas/DtoEnvironmentBase"},"value":{"type":"array","items":{"type":"array","items":{"type":"array","items":{}}}},"modifiedUtc":{"type":"string","format":"date-time"},"modifier":{"type":"string"},"version":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"}}},"DtoEnvironmentBase":{"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Unique identifier for the Environment","format":"int64"},"displayName":{"type":["null","string"],"description":"Display name for the Environment"}}},"PagingModel":{"type":"object","properties":{"currentPage":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Current page","format":"int32"},"pageSize":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Number of entries per page","format":"int32"},"totalCount":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Total number of entries","format":"int32"},"firstPage":{"type":["null","string"],"description":"Url of the first page","format":"uri"},"lastPage":{"type":["null","string"],"description":"Url of the last page","format":"uri"},"nextPage":{"type":["null","string"],"description":"Url of the next page","format":"uri"},"previousPage":{"type":["null","string"],"description":"Url of the previous page","format":"uri"}}}}}}
```

## The PagedResponseOfDtoProcessDeploymentGet object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"PagedResponseOfDtoProcessDeploymentGet":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/DtoProcessDeploymentGet"},"description":"Response data"},"paging":{"description":"Response paging","$ref":"#/components/schemas/PagingModel"}}},"DtoProcessDeploymentGet":{"required":["agentGroup","deploymentId","processId","processName","processGuid","processVersion","processBuildVersion","triggersActive"],"type":"object","properties":{"agentGroup":{"$ref":"#/components/schemas/DtoAgentGroupBase"},"deploymentId":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Unique identifier for the deployment.","format":"int64"},"processId":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Unique identifier for Process version.","format":"int64"},"processName":{"type":["null","string"],"description":"Process name"},"processGuid":{"type":"string","description":"Process unique identifier. This is shared between all versions of the Process.","format":"uuid"},"processVersion":{"type":["null","string"],"description":"Process version in the format X.Y.Z."},"processBuildVersion":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Process build version. This version is incremented by 1 on every successful Process build.","format":"int32"},"deployedAtUtc":{"type":["null","string"],"format":"date-time"},"deployedBy":{"type":["null","string"]},"description":{"type":["null","string"],"description":"Optional description for deployment"},"triggersActive":{"type":"boolean","description":"Are Process Triggers active"}}},"DtoAgentGroupBase":{"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Unique identifier for the Agent Group","format":"int64"},"displayName":{"type":["null","string"],"description":"Display name for the Agent Group"}}},"PagingModel":{"type":"object","properties":{"currentPage":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Current page","format":"int32"},"pageSize":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Number of entries per page","format":"int32"},"totalCount":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Total number of entries","format":"int32"},"firstPage":{"type":["null","string"],"description":"Url of the first page","format":"uri"},"lastPage":{"type":["null","string"],"description":"Url of the last page","format":"uri"},"nextPage":{"type":["null","string"],"description":"Url of the next page","format":"uri"},"previousPage":{"type":["null","string"],"description":"Url of the previous page","format":"uri"}}}}}}
```

## The PagedResponseOfDtoProcessListGet object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"PagedResponseOfDtoProcessListGet":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/DtoProcessListGet"},"description":"Response data"},"paging":{"description":"Response paging","$ref":"#/components/schemas/PagingModel"}}},"DtoProcessListGet":{"required":["name"],"type":"object","properties":{"links":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/ProcessLinkModel"}]},"bpmn":{"type":"string"},"elementParameters":{"type":"array","items":{"$ref":"#/components/schemas/ElementParameters"}},"manualTrigger":{"type":"array","items":{"type":"array","items":{}}},"obsoleteTasks":{"type":"array","items":{"$ref":"#/components/schemas/TaskSelectionData"}},"draftId":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int64"},"idOfBaseProcessForDraft":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int64"},"isDraft":{"type":"boolean"},"isSubprocess":{"type":"boolean"},"triggerData":{"type":["null","array"],"items":{"type":"array","items":{}}},"majorVersion":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"minorVersion":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"activateIfNew":{"type":"boolean"},"frendsVersion":{"type":["null","string"]},"ignoreDependencyConflicts":{"type":["null","boolean"]},"documentationMarkdown":{"type":["null","string"]},"targetFramework":{"type":"string"},"apiSpecId":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int64"},"isForMonitoringRule":{"type":"boolean"},"validationOnly":{"type":"boolean"},"cancellationDisabled":{"type":"boolean"},"preserveReferencesAtCheckpoint":{"type":"boolean"},"processVariables":{"type":["null","array"],"items":{"$ref":"#/components/schemas/ProcessVariable"}},"processTemplateId":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int64"},"processTemplateDeviated":{"type":["null","string"],"format":"date-time"},"nextProcessTemplate":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/ProcessTemplate"}]},"performAdditionalSyntaxValidation":{"type":"boolean"},"isDeleted":{"type":"boolean"},"version":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"uniqueIdentifier":{"type":"string","format":"uuid"},"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"name":{"type":"string"},"modified":{"type":"string","format":"date-time"},"modifier":{"type":["null","string"]},"description":{"type":["null","string"]},"isNotLatestVersion":{"type":"boolean"},"changeDescription":{"type":["null","string"]}}},"ProcessLinkModel":{"type":"object","properties":{"deployments":{"description":"Get all deployments for all versions of this Process","$ref":"#/components/schemas/LinkModel"},"delete":{"description":"Delete the process","$ref":"#/components/schemas/LinkModel"}}},"LinkModel":{"required":["uri","method"],"type":"object","properties":{"uri":{"type":"string","format":"uri"},"method":{"type":"string"}}},"ElementParameters":{"type":"object","properties":{"id":{"type":["null","string"]},"type":{"$ref":"#/components/schemas/ElementType"},"parameters":{"type":["null","object"],"additionalProperties":{"type":"array","items":{"type":"array","items":{}}}},"selectedTypeId":{"type":["null","string"]},"promoteResultAs":{"type":["null","string"]},"name":{"type":["null","string"]},"description":{"type":["null","string"]},"isDefault":{"type":["null","boolean"]},"shouldRetry":{"type":["null","boolean"]},"maxRetryCount":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"},"shouldNotLogResult":{"type":["null","boolean"]},"shouldDispose":{"type":["null","boolean"]}}},"ElementType":{"enum":["Start","Task","Decision","SequenceFlow","ConditionBranch","Return","Throw","CallActivity","SubProcess","ParallelForeach","SequentialForeach","While","Expression","SubProcessStartNode","Catch","InclusiveGateway","InclusiveDecisionBranch","IntermediateReturn","GlobalErrorHandler","TestTask","SharedState","Dmn","DataObjectReference","DataStoreReference","HydrationPoint","ScheduledRehydration","SignalRehydration","NativeAi","Vdm"]},"TaskSelectionData":{"type":"object","properties":{"uri":{"type":"string"},"argumentsJson":{"type":["null","string"]},"returnType":{"type":["null","string"]},"name":{"type":"string"},"displayName":{"type":["null","string"]},"packageName":{"type":"string"},"description":{"type":["null","string"]},"isNotLatestVersion":{"type":"boolean"},"isStandard":{"type":"boolean"},"isDotNet":{"type":"boolean"}}},"ProcessVariable":{"type":"object","properties":{"name":{"type":["null","string"]},"value":{"type":["null","string"]},"isSecret":{"type":"boolean"},"mode":{"type":["null","string"]},"description":{"type":["null","string"]}}},"ProcessTemplate":{"required":["uniqueIdentifier","isListed","version","isDeleted","majorVersion","minorVersion","name","modifier","modified","targetFramework","frendsVersion","isSubProcess","staticRequiredEnvironmentVariablesJson","staticRequiredCertificatesJson","allowedMcpToolsJson"],"type":"object","properties":{"uniqueIdentifier":{"type":"string","format":"uuid"},"isListed":{"type":"boolean"},"version":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"isDeleted":{"type":"boolean"},"processVariablesJson":{"maxLength":2147483647,"type":["null","string"]},"processTags":{"maxLength":2147483647,"type":["null","string"]},"documentation":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/ProcessDocumentation"}]},"getVersion":{"pattern":"^\\d+(\\.\\d+){1,3}$","type":["null","string"]},"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"majorVersion":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"minorVersion":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"name":{"maxLength":512,"minLength":0,"type":"string"},"modifier":{"maxLength":256,"minLength":0,"type":"string"},"modified":{"type":"string","format":"date-time"},"targetFramework":{"maxLength":32,"minLength":0,"type":"string"},"frendsVersion":{"maxLength":64,"minLength":0,"type":"string"},"isSubProcess":{"type":"boolean"},"staticRequiredEnvironmentVariablesJson":{"maxLength":2147483647,"type":"string"},"staticRequiredCertificatesJson":{"maxLength":2147483647,"type":"string"},"description":{"maxLength":2147483647,"minLength":0,"type":["null","string"]},"changeDescription":{"maxLength":2147483647,"minLength":0,"type":["null","string"]},"bpmn":{"maxLength":2147483647,"minLength":0,"type":["null","string"]},"isForMonitoringRule":{"type":["null","boolean"]},"cancellationDisabled":{"type":["null","boolean"]},"elementParameters":{"maxLength":2147483647,"minLength":0,"type":["null","string"]},"promotedResultVariablesJson":{"maxLength":2147483647,"minLength":0,"type":["null","string"]},"usedSubprocessesJson":{"maxLength":2147483647,"minLength":0,"type":["null","string"]},"usedTasksJson":{"maxLength":2147483647,"minLength":0,"type":["null","string"]},"triggersJson":{"maxLength":2147483647,"minLength":0,"type":["null","string"]},"manualTriggerJson":{"maxLength":2147483647,"minLength":0,"type":["null","string"]},"allowedMcpToolsJson":{"maxLength":2147483647,"minLength":0,"type":"string"},"preserveReferencesAtCheckpoint":{"type":"boolean"}}},"ProcessDocumentation":{"required":["uniqueIdentifier","documentationMarkdown","modifier","majorVersion","minorVersion"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"uniqueIdentifier":{"type":"string","format":"uuid"},"documentationMarkdown":{"maxLength":2147483647,"type":"string"},"modifier":{"maxLength":256,"type":"string"},"majorVersion":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"minorVersion":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"modifiedUtc":{"type":"string","format":"date-time"}}},"PagingModel":{"type":"object","properties":{"currentPage":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Current page","format":"int32"},"pageSize":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Number of entries per page","format":"int32"},"totalCount":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Total number of entries","format":"int32"},"firstPage":{"type":["null","string"],"description":"Url of the first page","format":"uri"},"lastPage":{"type":["null","string"],"description":"Url of the last page","format":"uri"},"nextPage":{"type":["null","string"],"description":"Url of the next page","format":"uri"},"previousPage":{"type":["null","string"],"description":"Url of the previous page","format":"uri"}}}}}}
```

## The PagedResponseOfProcessTemplateListViewModel object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"PagedResponseOfProcessTemplateListViewModel":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ProcessTemplateListViewModel"},"description":"Response data"},"paging":{"description":"Response paging","$ref":"#/components/schemas/PagingModel"}}},"ProcessTemplateListViewModel":{"required":["name","modifier"],"type":"object","properties":{"templateTags":{"type":["null","array"],"items":{"type":"string"}},"isListed":{"type":"boolean"},"version":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"isDeleted":{"type":"boolean"},"processVariablesJson":{"type":["null","string"]},"processTags":{"type":["null","string"]},"uniqueIdentifier":{"type":"string","format":"uuid"},"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"name":{"type":"string"},"modifier":{"type":"string"},"modified":{"type":"string","format":"date-time"},"majorVersion":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"minorVersion":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"targetFramework":{"type":"string"},"frendsVersion":{"type":"string"},"isSubprocess":{"type":"boolean"},"staticRequiredEnvironmentVariablesJson":{"type":"string"},"staticRequiredCertificatesJson":{"type":"string"},"isForMonitoringRule":{"type":["null","boolean"]},"description":{"type":["null","string"]},"promotedResultVariablesJson":{"type":["null","string"]},"usedSubprocessesJson":{"type":["null","string"]},"usedTasksJson":{"type":["null","string"]},"triggersJson":{"type":["null","string"]},"manualTriggerJson":{"type":["null","string"]},"isCrossPlatform":{"type":"boolean"},"isDotNet":{"type":"boolean"}}},"PagingModel":{"type":"object","properties":{"currentPage":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Current page","format":"int32"},"pageSize":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Number of entries per page","format":"int32"},"totalCount":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Total number of entries","format":"int32"},"firstPage":{"type":["null","string"],"description":"Url of the first page","format":"uri"},"lastPage":{"type":["null","string"],"description":"Url of the last page","format":"uri"},"nextPage":{"type":["null","string"],"description":"Url of the next page","format":"uri"},"previousPage":{"type":["null","string"],"description":"Url of the previous page","format":"uri"}}}}}}
```

## The PagingModel object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"PagingModel":{"type":"object","properties":{"currentPage":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Current page","format":"int32"},"pageSize":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Number of entries per page","format":"int32"},"totalCount":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Total number of entries","format":"int32"},"firstPage":{"type":["null","string"],"description":"Url of the first page","format":"uri"},"lastPage":{"type":["null","string"],"description":"Url of the last page","format":"uri"},"nextPage":{"type":["null","string"],"description":"Url of the next page","format":"uri"},"previousPage":{"type":["null","string"],"description":"Url of the previous page","format":"uri"}}}}}}
```

## The ParameterLocation object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ParameterLocation":{"enum":["Query","Header","Path","Cookie"]}}}}
```

## The PolicyEndpointMethod object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"PolicyEndpointMethod":{"enum":["All","Get","Post","Put","Head","Delete","Patch","Options","Connect","Trace"]}}}}
```

## The PrivateApplicationTokenCreateModel object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"PrivateApplicationTokenCreateModel":{"required":["name","tokenClaims"],"type":"object","properties":{"name":{"type":"string","description":"Name of the token"},"tokenLifetimeDays":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"description":"Token lifetime in days","format":"int32"},"tokenClaims":{"description":"Token claims","$ref":"#/components/schemas/JsonObject"}}},"JsonObject":{"type":"object"}}}}
```

## The PrivateApplicationTokensResponse object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"PrivateApplicationTokensResponse":{"required":["tokens"],"type":"object","properties":{"tokenCount":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"tokens":{"type":"array","items":{"$ref":"#/components/schemas/PrivateApplicationTokenViewModel"}}}},"PrivateApplicationTokenViewModel":{"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Id of the token","format":"int64"},"name":{"type":"string","description":"Name of the token"},"expiryTimeUtc":{"type":"string","description":"Expiry time of the token","format":"date-time"},"createTimeUtc":{"type":"string","description":"Create time of the token","format":"date-time"},"tokenClaims":{"description":"Token claims","$ref":"#/components/schemas/JsonObject"},"creator":{"type":"string","description":"Creator of the token"},"revoker":{"type":["null","string"],"description":"Revoker of the token"},"revokeTimeUtc":{"type":["null","string"],"description":"Revoked time of the token","format":"date-time"},"revokeReason":{"type":["null","string"],"description":"Reason for revoking the token"},"fullToken":{"type":"string","description":"Raw token"},"payloadOnly":{"type":"string","description":"Only payload part of the token"}}},"JsonObject":{"type":"object"}}}}
```

## The PrivateApplicationTokenViewModel object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"PrivateApplicationTokenViewModel":{"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Id of the token","format":"int64"},"name":{"type":"string","description":"Name of the token"},"expiryTimeUtc":{"type":"string","description":"Expiry time of the token","format":"date-time"},"createTimeUtc":{"type":"string","description":"Create time of the token","format":"date-time"},"tokenClaims":{"description":"Token claims","$ref":"#/components/schemas/JsonObject"},"creator":{"type":"string","description":"Creator of the token"},"revoker":{"type":["null","string"],"description":"Revoker of the token"},"revokeTimeUtc":{"type":["null","string"],"description":"Revoked time of the token","format":"date-time"},"revokeReason":{"type":["null","string"],"description":"Reason for revoking the token"},"fullToken":{"type":"string","description":"Raw token"},"payloadOnly":{"type":"string","description":"Only payload part of the token"}}},"JsonObject":{"type":"object"}}}}
```

## The PrivateApplicationViewModel object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"PrivateApplicationViewModel":{"required":["id","modifier","modifiedUtc","hasTokens","hasActiveTokens","nextTokenExpiry","name","description","defaultTokenLifetimeDays","customTokenClaims","tags"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Id of the application","format":"int64"},"modifier":{"type":"string","description":"Modifier of the application"},"modifiedUtc":{"type":"string","description":"Last modified date of the application","format":"date-time"},"hasTokens":{"type":"boolean","description":"Indicates if the application contains tokens"},"hasActiveTokens":{"type":"boolean","description":"Indicates if the application contains not revoked tokens"},"nextTokenExpiry":{"type":["null","string"],"description":"Next token expiry date","format":"date-time"},"name":{"type":"string","description":"Name of the application"},"description":{"type":["null","string"],"description":"Description of the application"},"defaultTokenLifetimeDays":{"maximum":730,"minimum":1,"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Default token lifetime in days","format":"int32"},"customTokenClaims":{"description":"Custom token claims","$ref":"#/components/schemas/JsonObject"},"tags":{"type":"array","items":{"type":"string"},"description":"Tags for the application"}}},"JsonObject":{"type":"object"}}}}
```

## The ProblemDetails object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ProblemDetails":{"type":"object","properties":{"type":{"type":["null","string"]},"title":{"type":["null","string"]},"status":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"},"detail":{"type":["null","string"]},"instance":{"type":["null","string"]}}}}}}
```

## The ProcessCountsByAgentGroupAndProcessAndDateTime object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ProcessCountsByAgentGroupAndProcessAndDateTime":{"required":["executionCounts"],"type":"object","properties":{"executionCounts":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ProcessInstanceExecutionCounts"}}}}}},"ProcessInstanceExecutionCounts":{"type":"object","properties":{"running":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"},"latestRunning":{"type":["null","string"],"format":"date-time"},"successful":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"},"latestSuccessful":{"type":["null","string"],"format":"date-time"},"failed":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"},"latestFailed":{"type":["null","string"],"format":"date-time"},"erroredNotAcknowledged":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"},"latestExecutionState":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/ExecutionState"}]}}},"ExecutionState":{"enum":["Ok","Waiting","Launched","Starting","Started","Canceled","CanceledByTerminate","FinishedAsZombie","TerminatedByUser","ActionSkipped","Failed","Exception","Finished"]}}}}
```

## The ProcessDataModel object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ProcessDataModel":{"required":["name"],"type":"object","properties":{"bpmn":{"type":"string"},"elementParameters":{"type":"array","items":{"$ref":"#/components/schemas/ElementParameters"}},"manualTrigger":{"type":"array","items":{"type":"array","items":{}}},"obsoleteTasks":{"type":"array","items":{"$ref":"#/components/schemas/TaskSelectionData"}},"draftId":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int64"},"idOfBaseProcessForDraft":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int64"},"isDraft":{"type":"boolean"},"isSubprocess":{"type":"boolean"},"triggerData":{"type":["null","array"],"items":{"type":"array","items":{}}},"majorVersion":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"minorVersion":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"activateIfNew":{"type":"boolean"},"frendsVersion":{"type":["null","string"]},"ignoreDependencyConflicts":{"type":["null","boolean"]},"documentationMarkdown":{"type":["null","string"]},"targetFramework":{"type":"string"},"apiSpecId":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int64"},"isForMonitoringRule":{"type":"boolean"},"validationOnly":{"type":"boolean"},"cancellationDisabled":{"type":"boolean"},"preserveReferencesAtCheckpoint":{"type":"boolean"},"processVariables":{"type":["null","array"],"items":{"$ref":"#/components/schemas/ProcessVariable"}},"processTemplateId":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int64"},"processTemplateDeviated":{"type":["null","string"],"format":"date-time"},"nextProcessTemplate":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/ProcessTemplate"}]},"performAdditionalSyntaxValidation":{"type":"boolean"},"isDeleted":{"type":"boolean"},"version":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"uniqueIdentifier":{"type":"string","format":"uuid"},"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"name":{"type":"string"},"modified":{"type":"string","format":"date-time"},"modifier":{"type":["null","string"]},"description":{"type":["null","string"]},"isNotLatestVersion":{"type":"boolean"},"changeDescription":{"type":["null","string"]}}},"ElementParameters":{"type":"object","properties":{"id":{"type":["null","string"]},"type":{"$ref":"#/components/schemas/ElementType"},"parameters":{"type":["null","object"],"additionalProperties":{"type":"array","items":{"type":"array","items":{}}}},"selectedTypeId":{"type":["null","string"]},"promoteResultAs":{"type":["null","string"]},"name":{"type":["null","string"]},"description":{"type":["null","string"]},"isDefault":{"type":["null","boolean"]},"shouldRetry":{"type":["null","boolean"]},"maxRetryCount":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"},"shouldNotLogResult":{"type":["null","boolean"]},"shouldDispose":{"type":["null","boolean"]}}},"ElementType":{"enum":["Start","Task","Decision","SequenceFlow","ConditionBranch","Return","Throw","CallActivity","SubProcess","ParallelForeach","SequentialForeach","While","Expression","SubProcessStartNode","Catch","InclusiveGateway","InclusiveDecisionBranch","IntermediateReturn","GlobalErrorHandler","TestTask","SharedState","Dmn","DataObjectReference","DataStoreReference","HydrationPoint","ScheduledRehydration","SignalRehydration","NativeAi","Vdm"]},"TaskSelectionData":{"type":"object","properties":{"uri":{"type":"string"},"argumentsJson":{"type":["null","string"]},"returnType":{"type":["null","string"]},"name":{"type":"string"},"displayName":{"type":["null","string"]},"packageName":{"type":"string"},"description":{"type":["null","string"]},"isNotLatestVersion":{"type":"boolean"},"isStandard":{"type":"boolean"},"isDotNet":{"type":"boolean"}}},"ProcessVariable":{"type":"object","properties":{"name":{"type":["null","string"]},"value":{"type":["null","string"]},"isSecret":{"type":"boolean"},"mode":{"type":["null","string"]},"description":{"type":["null","string"]}}},"ProcessTemplate":{"required":["uniqueIdentifier","isListed","version","isDeleted","majorVersion","minorVersion","name","modifier","modified","targetFramework","frendsVersion","isSubProcess","staticRequiredEnvironmentVariablesJson","staticRequiredCertificatesJson","allowedMcpToolsJson"],"type":"object","properties":{"uniqueIdentifier":{"type":"string","format":"uuid"},"isListed":{"type":"boolean"},"version":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"isDeleted":{"type":"boolean"},"processVariablesJson":{"maxLength":2147483647,"type":["null","string"]},"processTags":{"maxLength":2147483647,"type":["null","string"]},"documentation":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/ProcessDocumentation"}]},"getVersion":{"pattern":"^\\d+(\\.\\d+){1,3}$","type":["null","string"]},"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"majorVersion":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"minorVersion":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"name":{"maxLength":512,"minLength":0,"type":"string"},"modifier":{"maxLength":256,"minLength":0,"type":"string"},"modified":{"type":"string","format":"date-time"},"targetFramework":{"maxLength":32,"minLength":0,"type":"string"},"frendsVersion":{"maxLength":64,"minLength":0,"type":"string"},"isSubProcess":{"type":"boolean"},"staticRequiredEnvironmentVariablesJson":{"maxLength":2147483647,"type":"string"},"staticRequiredCertificatesJson":{"maxLength":2147483647,"type":"string"},"description":{"maxLength":2147483647,"minLength":0,"type":["null","string"]},"changeDescription":{"maxLength":2147483647,"minLength":0,"type":["null","string"]},"bpmn":{"maxLength":2147483647,"minLength":0,"type":["null","string"]},"isForMonitoringRule":{"type":["null","boolean"]},"cancellationDisabled":{"type":["null","boolean"]},"elementParameters":{"maxLength":2147483647,"minLength":0,"type":["null","string"]},"promotedResultVariablesJson":{"maxLength":2147483647,"minLength":0,"type":["null","string"]},"usedSubprocessesJson":{"maxLength":2147483647,"minLength":0,"type":["null","string"]},"usedTasksJson":{"maxLength":2147483647,"minLength":0,"type":["null","string"]},"triggersJson":{"maxLength":2147483647,"minLength":0,"type":["null","string"]},"manualTriggerJson":{"maxLength":2147483647,"minLength":0,"type":["null","string"]},"allowedMcpToolsJson":{"maxLength":2147483647,"minLength":0,"type":"string"},"preserveReferencesAtCheckpoint":{"type":"boolean"}}},"ProcessDocumentation":{"required":["uniqueIdentifier","documentationMarkdown","modifier","majorVersion","minorVersion"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"uniqueIdentifier":{"type":"string","format":"uuid"},"documentationMarkdown":{"maxLength":2147483647,"type":"string"},"modifier":{"maxLength":256,"type":"string"},"majorVersion":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"minorVersion":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"modifiedUtc":{"type":"string","format":"date-time"}}}}}}
```

## The ProcessDocumentation object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ProcessDocumentation":{"required":["uniqueIdentifier","documentationMarkdown","modifier","majorVersion","minorVersion"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"uniqueIdentifier":{"type":"string","format":"uuid"},"documentationMarkdown":{"maxLength":2147483647,"type":"string"},"modifier":{"maxLength":256,"type":"string"},"majorVersion":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"minorVersion":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"modifiedUtc":{"type":"string","format":"date-time"}}}}}}
```

## The ProcessInstanceExecutionCounts object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ProcessInstanceExecutionCounts":{"type":"object","properties":{"running":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"},"latestRunning":{"type":["null","string"],"format":"date-time"},"successful":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"},"latestSuccessful":{"type":["null","string"],"format":"date-time"},"failed":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"},"latestFailed":{"type":["null","string"],"format":"date-time"},"erroredNotAcknowledged":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"},"latestExecutionState":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/ExecutionState"}]}}},"ExecutionState":{"enum":["Ok","Waiting","Launched","Starting","Started","Canceled","CanceledByTerminate","FinishedAsZombie","TerminatedByUser","ActionSkipped","Failed","Exception","Finished"]}}}}
```

## The ProcessInstanceExecutionDetailsViewModel object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ProcessInstanceExecutionDetailsViewModel":{"required":["parentName","processGuid","rootProcessGuid","environment","agentGroup","agent","userName","triggerName","processParameters","processReturnValues"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"parentId":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int64"},"parentName":{"type":"string"},"executionId":{"type":"string","format":"uuid"},"processGuid":{"type":"string","format":"uuid"},"rootProcessGuid":{"type":["null","string"],"format":"uuid"},"processVersion":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"state":{"$ref":"#/components/schemas/ExecutionState"},"dehydrationState":{"$ref":"#/components/schemas/DehydrationState"},"stepDataUri":{"type":["null","string"]},"startTimeUtc":{"type":["null","string"],"format":"date-time"},"endTimeUtc":{"type":["null","string"],"format":"date-time"},"duration":{"pattern":"^-?(\\d+\\.)?\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,7})?$","type":["null","string"]},"environment":{"type":"string"},"agentGroup":{"type":"string"},"agent":{"type":"string"},"exception":{"type":["null","string"]},"userName":{"type":"string"},"triggerName":{"type":"string"},"processParameters":{"type":["null","array"],"items":{"type":"array","items":{"type":"array","items":{}}}},"processReturnValues":{"type":["null","array"],"items":{"type":"array","items":{}}},"hasLoggedSteps":{"type":["null","boolean"]},"correlationId":{"type":["null","string"]}}},"ExecutionState":{"enum":["Ok","Waiting","Launched","Starting","Started","Canceled","CanceledByTerminate","FinishedAsZombie","TerminatedByUser","ActionSkipped","Failed","Exception","Finished"]},"DehydrationState":{"enum":["Dehydrated","Hydrated","DehydrationProcessFailure",null]}}}}
```

## The ProcessInstanceFilter object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ProcessInstanceFilter":{"enum":["ShowAll","ShowRunning","ShowFinished","ShowSuccessful","ShowFailed","ShowFailedNotAcknowledged",null]}}}}
```

## The ProcessInstanceViewModel object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ProcessInstanceViewModel":{"type":"object","properties":{"triggerName":{"type":["null","string"]},"environmentName":{"type":["null","string"]},"agentGroupName":{"type":["null","string"]},"agentName":{"type":["null","string"]},"processGuid":{"type":"string","format":"uuid"},"parentName":{"type":["null","string"]},"triggerRequest":{"type":["null","array"],"items":{"type":"array","items":{"type":"array","items":{}}}},"triggerResponses":{"type":["null","array"],"items":{"type":"array","items":{}}},"promotedColumns":{"type":["null","array"],"items":{"$ref":"#/components/schemas/PromotedColumn"}},"dehydrationState":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/DehydrationState"}]},"correlationId":{"type":["null","string"]},"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"parentId":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int64"},"processId":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"rootProcessId":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"},"processVersion":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"state":{"$ref":"#/components/schemas/ExecutionState"},"startTimeUtc":{"type":["null","string"],"format":"date-time"},"endTimeUtc":{"type":["null","string"],"format":"date-time"},"utcDate":{"type":"string","format":"date-time"},"utcHour":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int16"},"executionId":{"type":"string","format":"uuid"},"triggerId":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"},"agentId":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"environmentId":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"agentGroupId":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"exception":{"type":["null","string"]},"userName":{"type":["null","string"]},"hasLoggedSteps":{"type":["null","boolean"]},"acknowledgedUtc":{"type":["null","string"],"format":"date-time"},"commentJson":{"type":["null","string"]},"comment":{"type":"string"},"promotedData":{"type":["null","array"],"items":{"$ref":"#/components/schemas/ProcessPromotedData"}}}},"PromotedColumn":{"type":"object","properties":{"name":{"type":["null","string"]},"value":{"type":["null","array"],"items":{"type":"array","items":{}}}}},"DehydrationState":{"enum":["Dehydrated","Hydrated","DehydrationProcessFailure",null]},"ExecutionState":{"enum":["Ok","Waiting","Launched","Starting","Started","Canceled","CanceledByTerminate","FinishedAsZombie","TerminatedByUser","ActionSkipped","Failed","Exception","Finished"]},"ProcessPromotedData":{"required":["environmentName","promotedVariableName","promotedValueJson"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"processExecutionId":{"type":"string","format":"uuid"},"timeStamp":{"type":"string","format":"date-time"},"environmentName":{"type":"string"},"promotedVariableName":{"type":"string"},"promotedValueJson":{"type":"string"}}}}}}
```

## The ProcessLinkModel object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ProcessLinkModel":{"type":"object","properties":{"deployments":{"description":"Get all deployments for all versions of this Process","$ref":"#/components/schemas/LinkModel"},"delete":{"description":"Delete the process","$ref":"#/components/schemas/LinkModel"}}},"LinkModel":{"required":["uri","method"],"type":"object","properties":{"uri":{"type":"string","format":"uri"},"method":{"type":"string"}}}}}}
```

## The ProcessPromotedData object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ProcessPromotedData":{"required":["environmentName","promotedVariableName","promotedValueJson"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"processExecutionId":{"type":"string","format":"uuid"},"timeStamp":{"type":"string","format":"date-time"},"environmentName":{"type":"string"},"promotedVariableName":{"type":"string"},"promotedValueJson":{"type":"string"}}}}}}
```

## The ProcessTemplate object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ProcessTemplate":{"required":["uniqueIdentifier","isListed","version","isDeleted","majorVersion","minorVersion","name","modifier","modified","targetFramework","frendsVersion","isSubProcess","staticRequiredEnvironmentVariablesJson","staticRequiredCertificatesJson","allowedMcpToolsJson"],"type":"object","properties":{"uniqueIdentifier":{"type":"string","format":"uuid"},"isListed":{"type":"boolean"},"version":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"isDeleted":{"type":"boolean"},"processVariablesJson":{"maxLength":2147483647,"type":["null","string"]},"processTags":{"maxLength":2147483647,"type":["null","string"]},"documentation":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/ProcessDocumentation"}]},"getVersion":{"pattern":"^\\d+(\\.\\d+){1,3}$","type":["null","string"]},"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"majorVersion":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"minorVersion":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"name":{"maxLength":512,"minLength":0,"type":"string"},"modifier":{"maxLength":256,"minLength":0,"type":"string"},"modified":{"type":"string","format":"date-time"},"targetFramework":{"maxLength":32,"minLength":0,"type":"string"},"frendsVersion":{"maxLength":64,"minLength":0,"type":"string"},"isSubProcess":{"type":"boolean"},"staticRequiredEnvironmentVariablesJson":{"maxLength":2147483647,"type":"string"},"staticRequiredCertificatesJson":{"maxLength":2147483647,"type":"string"},"description":{"maxLength":2147483647,"minLength":0,"type":["null","string"]},"changeDescription":{"maxLength":2147483647,"minLength":0,"type":["null","string"]},"bpmn":{"maxLength":2147483647,"minLength":0,"type":["null","string"]},"isForMonitoringRule":{"type":["null","boolean"]},"cancellationDisabled":{"type":["null","boolean"]},"elementParameters":{"maxLength":2147483647,"minLength":0,"type":["null","string"]},"promotedResultVariablesJson":{"maxLength":2147483647,"minLength":0,"type":["null","string"]},"usedSubprocessesJson":{"maxLength":2147483647,"minLength":0,"type":["null","string"]},"usedTasksJson":{"maxLength":2147483647,"minLength":0,"type":["null","string"]},"triggersJson":{"maxLength":2147483647,"minLength":0,"type":["null","string"]},"manualTriggerJson":{"maxLength":2147483647,"minLength":0,"type":["null","string"]},"allowedMcpToolsJson":{"maxLength":2147483647,"minLength":0,"type":"string"},"preserveReferencesAtCheckpoint":{"type":"boolean"}}},"ProcessDocumentation":{"required":["uniqueIdentifier","documentationMarkdown","modifier","majorVersion","minorVersion"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"uniqueIdentifier":{"type":"string","format":"uuid"},"documentationMarkdown":{"maxLength":2147483647,"type":"string"},"modifier":{"maxLength":256,"type":"string"},"majorVersion":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"minorVersion":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"modifiedUtc":{"type":"string","format":"date-time"}}}}}}
```

## The ProcessTemplateBase object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ProcessTemplateBase":{"required":["name","bpmn"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"name":{"type":["null","string"]},"modifier":{"type":["null","string"]},"modified":{"type":"string","format":"date-time"},"majorVersion":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"minorVersion":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"targetFramework":{"type":"string"},"frendsVersion":{"type":"string"},"isSubprocess":{"type":"boolean"},"staticRequiredEnvironmentVariablesJson":{"type":"string"},"isForMonitoringRule":{"type":"boolean"},"cancellationDisabled":{"type":"boolean"},"preserveReferencesAtCheckpoint":{"type":"boolean"},"description":{"type":["null","string"]},"changeDescription":{"type":["null","string"]},"bpmn":{"type":["null","string"]},"elementParameters":{"type":["null","string"]},"promotedResultVariablesJson":{"type":["null","string"]},"usedSubprocessesJson":{"type":["null","string"]},"usedTasksJson":{"type":["null","string"]},"triggersJson":{"type":["null","string"]},"manualTriggerJson":{"type":["null","string"]},"allowedMcpToolsJson":{"type":"string"},"uniqueIdentifier":{"type":"string","format":"uuid"},"isListed":{"type":"boolean"},"version":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"isDeleted":{"type":"boolean"},"processVariablesJson":{"type":["null","string"]},"processTags":{"type":["null","string"]},"templateTags":{"type":"array","items":{"type":"string"}},"getVersion":{"pattern":"^\\d+(\\.\\d+){1,3}$","type":["null","string"]}}}}}}
```

## The ProcessTemplateListViewModel object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ProcessTemplateListViewModel":{"required":["name","modifier"],"type":"object","properties":{"templateTags":{"type":["null","array"],"items":{"type":"string"}},"isListed":{"type":"boolean"},"version":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"isDeleted":{"type":"boolean"},"processVariablesJson":{"type":["null","string"]},"processTags":{"type":["null","string"]},"uniqueIdentifier":{"type":"string","format":"uuid"},"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"name":{"type":"string"},"modifier":{"type":"string"},"modified":{"type":"string","format":"date-time"},"majorVersion":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"minorVersion":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"targetFramework":{"type":"string"},"frendsVersion":{"type":"string"},"isSubprocess":{"type":"boolean"},"staticRequiredEnvironmentVariablesJson":{"type":"string"},"staticRequiredCertificatesJson":{"type":"string"},"isForMonitoringRule":{"type":["null","boolean"]},"description":{"type":["null","string"]},"promotedResultVariablesJson":{"type":["null","string"]},"usedSubprocessesJson":{"type":["null","string"]},"usedTasksJson":{"type":["null","string"]},"triggersJson":{"type":["null","string"]},"manualTriggerJson":{"type":["null","string"]},"isCrossPlatform":{"type":"boolean"},"isDotNet":{"type":"boolean"}}}}}}
```

## The ProcessTemplateTagRequestModel object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ProcessTemplateTagRequestModel":{"required":["tags","overwrite","templateIds"],"type":"object","properties":{"tags":{"type":"array","items":{"type":"string"},"description":"Tags to be added to the Process templates"},"overwrite":{"type":"boolean","description":"If true the tags will be overwritten"},"templateIds":{"type":"array","items":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"description":"List of Process template ids"}}}}}}
```

## The ProcessVariable object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ProcessVariable":{"type":"object","properties":{"name":{"type":["null","string"]},"value":{"type":["null","string"]},"isSecret":{"type":"boolean"},"mode":{"type":["null","string"]},"description":{"type":["null","string"]}}}}}}
```

## The ProcessVersionInputModel object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ProcessVersionInputModel":{"type":"object","properties":{"processGuid":{"type":"string","format":"uuid"},"version":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"processVariables":{"type":["null","array"],"items":{"$ref":"#/components/schemas/ProcessVariable"}}}},"ProcessVariable":{"type":"object","properties":{"name":{"type":["null","string"]},"value":{"type":["null","string"]},"isSecret":{"type":"boolean"},"mode":{"type":["null","string"]},"description":{"type":["null","string"]}}}}}}
```

## The PromotedColumn object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"PromotedColumn":{"type":"object","properties":{"name":{"type":["null","string"]},"value":{"type":["null","array"],"items":{"type":"array","items":{}}}}}}}}
```

## The PublishApiRequest object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"PublishApiRequest":{"type":"object","properties":{"changeDescription":{"type":["null","string"],"description":"Description of the changes made"}}}}}}
```

## The ResponseOfApiPassthroughViewModel object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ResponseOfApiPassthroughViewModel":{"required":["data"],"type":"object","properties":{"data":{"oneOf":[{"type":"null"},{"description":"Response data","$ref":"#/components/schemas/ApiPassthroughViewModel"}]}}},"ApiPassthroughViewModel":{"required":["id","apiVersionId","modifier","modified","path","method","isDefault","corsEnabled","targetUrl","headers","allowedOrigins"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Unique identifier of the passthrough configuration","format":"int64"},"apiVersionId":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Unique identifier of the API version","format":"int64"},"modifier":{"type":"string","description":"User who last modified the configuration"},"modified":{"type":"string","description":"Time when configuration was last modified","format":"date-time"},"path":{"type":["null","string"],"description":"Source API path for this passthrough configuration. Not used when IsDefault is set to true."},"method":{"type":["null","string"],"description":"HTTP method. Not used when IsDefault is set to true."},"isDefault":{"type":"boolean","description":"Is this configuration used for all paths and HTTP methods"},"corsEnabled":{"type":"boolean","description":"Is CORS enabled"},"targetUrl":{"description":"Target URL","$ref":"#/components/schemas/ApiPassthroughTarget"},"headers":{"type":["null","array"],"items":{"$ref":"#/components/schemas/ApiPassthroughHeader"},"description":"Header definitions"},"allowedOrigins":{"type":["null","array"],"items":{"type":"string"},"description":"Allowed origins. Used when CORS is enabled."}}},"ApiPassthroughTarget":{"required":["server","basePath","operationPath","query"],"type":"object","properties":{"server":{"type":"string","description":"Server part of the target URL"},"basePath":{"type":"string","description":"Base path of the target URL"},"operationPath":{"type":["null","string"],"description":"Operation path of the target URL"},"query":{"type":["null","string"],"description":"Query parameters of the target URL"}}},"ApiPassthroughHeader":{"required":["action","name","value"],"type":"object","properties":{"action":{"type":"string","description":"Header action (Add, Overwrite, Remove)"},"name":{"type":"string","description":"Header name"},"value":{"type":"string","description":"Header value"}}}}}}
```

## The ResponseOfApiPolicyViewModel object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ResponseOfApiPolicyViewModel":{"required":["data"],"type":"object","properties":{"data":{"oneOf":[{"type":"null"},{"description":"Response data","$ref":"#/components/schemas/ApiPolicyViewModel"}]}}},"ApiPolicyViewModel":{"required":["name"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"The identifier of the policy","format":"int64"},"uniqueIdentifier":{"type":"string","description":"The globally unique identifier of the policy","format":"uuid"},"modifier":{"type":["null","string"],"description":"The modifier of the policy"},"modifiedUtc":{"type":"string","description":"The timestamp when the policy was last modified","format":"date-time"},"targetEndpoints":{"type":["null","array"],"items":{"$ref":"#/components/schemas/ApiPolicyTargetEndpointViewModel"},"description":"The list of target endpoints associated with the policy"},"identities":{"type":["null","array"],"items":{"$ref":"#/components/schemas/ApiPolicyIdentityViewModel"},"description":"The list of identities associated with the policy"},"apiKeyGroups":{"type":["null","array"],"items":{"$ref":"#/components/schemas/ApiPolicyApiKeyGroupViewModel"},"description":"The list of API key groups associated with the policy"},"publicAccessDeployments":{"type":["null","array"],"items":{"$ref":"#/components/schemas/ApiPolicyDeploymentViewModel"},"description":"The list of deployments connected with public access identity"},"requestLoggingOptions":{"type":["null","array"],"items":{"$ref":"#/components/schemas/ApiPolicyRequestLoggingViewModel"},"description":"The list of request logging options associated with the api policy"},"name":{"type":"string","description":"The name of the policy"},"description":{"type":["null","string"],"description":"The description of the policy"},"tags":{"type":["null","array"],"items":{"type":"string"},"description":"The tags of the policy"},"allowPublicAccess":{"type":"boolean","description":"Determines if public access is allowed"},"apiKeyName":{"type":"string","description":"The name of the API key"},"apiKeyLocation":{"description":"The location of the API key","$ref":"#/components/schemas/ParameterLocation"}}},"ApiPolicyTargetEndpointViewModel":{"required":["path"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"The unique identifier of the target endpoint","format":"int64"},"path":{"type":"string","description":"The path of the target endpoint"},"method":{"description":"The HTTP method of the target endpoint","$ref":"#/components/schemas/PolicyEndpointMethod"},"requestLimit":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"description":"The maximum amount of requests. Not null value requires RequestLimitWindowInMinutes to be set.","format":"int32"},"requestLimitWindowInMinutes":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"description":"The request limit window in minutes. Not null value requires RequestLimit to be set.","format":"int32"}}},"PolicyEndpointMethod":{"enum":["All","Get","Post","Put","Head","Delete","Patch","Options","Connect","Trace"]},"ApiPolicyIdentityViewModel":{"required":["issuers","name"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"The unique identifier of the identity","format":"int64"},"identityRules":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyIdentityRuleViewModel"}},"deployments":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyDeploymentViewModel"},"description":"The list of deployments associated with the identity"},"isPrivateApplication":{"type":"boolean","description":"Determines if it is a private application"},"issuers":{"description":"The issuers of the identity","$ref":"#/components/schemas/JsonArray"},"name":{"type":"string","description":"The name of the identity"},"throttlingByClaim":{"type":["null","string"],"description":"The throttling by claim for the identity"},"priorityNumber":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"In case of 2 or more matching identities, determines which identity to use. Lower number will be selected.","format":"int32"},"requestLimit":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"description":"The maximum amount of requests. Not null value requires RequestLimitWindowInMinutes to be set.","format":"int32"},"requestLimitWindowInMinutes":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"description":"The request limit window in minutes. Not null value requires RequestLimit to be set.","format":"int32"}}},"ApiPolicyIdentityRuleViewModel":{"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"The unique identifier of the identity rule","format":"int64"},"ruleType":{"description":"The type of access rule","$ref":"#/components/schemas/ApiAccessRuleType"},"claim":{"type":["null","string"],"description":"The claim associated with the identity rule"},"value":{"type":["null","string"],"description":"The value associated with the identity rule"},"matchType":{"description":"The match type of the identity rule","$ref":"#/components/schemas/IdentityRuleMatchType"}}},"ApiAccessRuleType":{"enum":["Allow","Deny"]},"IdentityRuleMatchType":{"enum":["Exact","Exists","Regex"]},"ApiPolicyDeploymentViewModel":{"required":["agentGroupName"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"The unique identifier of the deployment","format":"int64"},"deployerUserName":{"type":"string","description":"The username of the deployer"},"deployedUtc":{"type":"string","description":"The timestamp when the deployment occurred","format":"date-time"},"agentGroupName":{"type":"string","description":"The Agent Group associated with the deployment"}}},"JsonArray":{"type":"array"},"ApiPolicyApiKeyGroupViewModel":{"required":["name"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"The unique identifier of the API key group","format":"int64"},"apiPolicyApiKeyGroupAssignments":{"type":["null","array"],"items":{"$ref":"#/components/schemas/ApiPolicyApiKeyGroupAssignmentViewModel"},"description":"The API group assignments"},"name":{"type":"string","description":"The name of the API key group"},"requestLimit":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"description":"The maximum amount of requests. Not null value requires RequestLimitWindowInMinutes to be set.","format":"int32"},"requestLimitWindowInMinutes":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"description":"The request limit window in minutes. Not null value requires RequestLimit to be set.","format":"int32"}}},"ApiPolicyApiKeyGroupAssignmentViewModel":{"required":["apiKey"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"The identifier of the assignment","format":"int64"},"apiKey":{"description":"The API key","$ref":"#/components/schemas/ApiKeyViewModel"}}},"ApiKeyViewModel":{"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"name":{"type":["null","string"]},"environment":{"type":["null","string"]},"value":{"type":"string","format":"uuid"}}},"ApiPolicyRequestLoggingViewModel":{"required":["name","loggingFields"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"The unique identifier of the request logging","format":"int64"},"deployments":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyDeploymentViewModel"},"description":"The list of deployments associated with the request logging"},"name":{"type":"string","description":"The name of the request logging"},"loggingFields":{"description":"The fields logged by request logging","$ref":"#/components/schemas/JsonArray"},"ipLogging":{"description":"IpLoggingType of the request logging","$ref":"#/components/schemas/IpLoggingType"},"requestBodyMaxLengthKb":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Request body maximum length for request logging","format":"int32"},"responseBodyMaxLengthKb":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Response body maximum length for request logging","format":"int32"},"disableLogging":{"type":"boolean","description":"Disable logging for request logging"}}},"IpLoggingType":{"enum":["ClientIP","ClientIPXForwardedForFirst","ClientIPXForwardedForAll","Disable"]},"ParameterLocation":{"enum":["Query","Header","Path","Cookie"]}}}}
```

## The ResponseOfDictionaryOfGuidAndListOfstring object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ResponseOfDictionaryOfGuidAndListOfstring":{"required":["data"],"type":"object","properties":{"data":{"type":["null","object"],"additionalProperties":{"type":"array","items":{"type":"string"}},"description":"Response data"}}}}}}
```

## The ResponseOfDictionaryOflongAndListOfProcessVariable object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ResponseOfDictionaryOflongAndListOfProcessVariable":{"required":["data"],"type":"object","properties":{"data":{"type":["null","object"],"additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/ProcessVariable"}},"description":"Response data"}}},"ProcessVariable":{"type":"object","properties":{"name":{"type":["null","string"]},"value":{"type":["null","string"]},"isSecret":{"type":"boolean"},"mode":{"type":["null","string"]},"description":{"type":["null","string"]}}}}}}
```

## The ResponseOfDtoAcmeAccountGet object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ResponseOfDtoAcmeAccountGet":{"required":["data"],"type":"object","properties":{"data":{"oneOf":[{"type":"null"},{"description":"Response data","$ref":"#/components/schemas/DtoAcmeAccountGet"}]}}},"DtoAcmeAccountGet":{"required":["accountGuid","provider","acmeDirectoryUrl","email","accountUri","hasExternalAccountBinding","managedByFrends","createdUtc"],"type":"object","properties":{"accountGuid":{"type":"string","description":"Account unique identifier","format":"uuid"},"provider":{"type":"string","description":"Provider name"},"acmeDirectoryUrl":{"type":"string","description":"ACME directory URL"},"email":{"type":["null","string"],"description":"Optional contact email for the ACME account"},"accountUri":{"type":["null","string"],"description":"ACME account URI as returned by the ACME server"},"hasExternalAccountBinding":{"type":"boolean","description":"Whether this account was created with external account binding (EAB)"},"managedByFrends":{"type":"boolean","description":"Whether the account is managed by Frends operations (only the FrendsOps role can create or delete it)"},"createdUtc":{"type":"string","description":"Creation timestamp (UTC)","format":"date-time"}}}}}}
```

## The ResponseOfDtoAcmeOrderGet object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ResponseOfDtoAcmeOrderGet":{"required":["data"],"type":"object","properties":{"data":{"oneOf":[{"type":"null"},{"description":"Response data","$ref":"#/components/schemas/DtoAcmeOrderGet"}]}}},"DtoAcmeOrderGet":{"required":["orderGuid","domain","certificateName","challengeType","status","dnsTxtRecordName","dnsTxtValue","lastError","agentGroupName","managedByFrends","certificateGuid","createdUtc","expiresUtc","completedUtc"],"type":"object","properties":{"orderGuid":{"type":"string","description":"Order unique identifier","format":"uuid"},"domain":{"type":"string","description":"Domain name the order is for"},"certificateName":{"type":"string","description":"Name of the certificate the order issues; renewals reuse it"},"challengeType":{"type":"string","description":"Challenge type used for this order"},"status":{"type":"string","description":"Order status, normalized to RFC 8555 lowercase (pending/ready/processing/valid/invalid), or revoked once the issued certificate has been revoked at the CA"},"dnsTxtRecordName":{"type":["null","string"],"description":"DNS TXT record name to create for the dns-01 or dns-persist-01 challenge; null for http-01"},"dnsTxtValue":{"type":["null","string"],"description":"DNS TXT record value to create for the dns-01 or dns-persist-01 challenge; null for http-01"},"lastError":{"type":["null","string"],"description":"Last error encountered while processing the order, if any"},"agentGroupName":{"type":"string","description":"Agent group name the order belongs to"},"managedByFrends":{"type":"boolean","description":"True when the agent group is operated by Frends: only the FrendsOps role can create, validate or finalize the order"},"certificateGuid":{"type":["null","string"],"description":"Certificate unique identifier, set once the order has been finalized","format":"uuid"},"createdUtc":{"type":"string","description":"Creation timestamp (UTC)","format":"date-time"},"expiresUtc":{"type":["null","string"],"description":"Order expiry timestamp (UTC), if known","format":"date-time"},"completedUtc":{"type":["null","string"],"description":"Completion timestamp (UTC), set once finalized","format":"date-time"},"revokedUtc":{"type":["null","string"],"description":"Revocation timestamp (UTC), set once the issued certificate has been revoked at the CA","format":"date-time"},"revocationReason":{"type":["null","string"],"description":"Revocation reason given to the CA, set together with RevokedUtc"}}}}}}
```

## The ResponseOfDtoAgentGroupGet object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ResponseOfDtoAgentGroupGet":{"required":["data"],"type":"object","properties":{"data":{"oneOf":[{"type":"null"},{"description":"Response data","$ref":"#/components/schemas/DtoAgentGroupGet"}]}}},"DtoAgentGroupGet":{"type":"object","properties":{"internalName":{"type":["null","string"],"description":"Internal name used by Frends for the Agent Group"},"agents":{"type":["null","array"],"items":{"type":"string"},"description":"The Agents that belong to the Agent Group"},"environment":{"description":"The Environment to which the Agent Group belongs","$ref":"#/components/schemas/DtoEnvironmentBase"},"agentDetails":{"type":["null","array"],"items":{"$ref":"#/components/schemas/DtoAgentGet"},"description":"Details about the Agents that belong to the Agent Group"},"agentRegistrationMode":{"description":"The registration mode that determines the lifecycle policy for agents in this group","$ref":"#/components/schemas/AgentRegistrationMode"},"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Unique identifier for the Agent Group","format":"int64"},"displayName":{"type":["null","string"],"description":"Display name for the Agent Group"}}},"DtoEnvironmentBase":{"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Unique identifier for the Environment","format":"int64"},"displayName":{"type":["null","string"],"description":"Display name for the Environment"}}},"DtoAgentGet":{"type":"object","properties":{"url":{"type":["null","string"],"description":"The hostname or address for the agent. Can either be full URL https://example.org:1234 or hostname subdomain.example.org"},"httpPorts":{"type":["null","array"],"items":{"type":"string"},"description":"List of http ports the Agent listens to. If the Url is a full address (schema://hostname:port?) this can be ignored."},"httpsPorts":{"type":["null","array"],"items":{"type":"string"},"description":"List of https ports the Agent listens to. If the Url is a full address (schema://hostname:port?) this can be ignored."},"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Agent Identifier","format":"int64"},"name":{"type":["null","string"],"description":"Agent name"},"isGateway":{"type":"boolean","description":"If the agent is a Gateway Agent. If true, these Agents are the ones that should primarily be accessible from the internet."},"isCloudAgent":{"type":"boolean","description":"If the agent is a Cloud Agent. If true, the agent is managed by Frends."}}},"AgentRegistrationMode":{"enum":["SelfHosted","Deployment","Cloud","StatefulSet"]}}}}
```

## The ResponseOfDtoAgentStatusGet object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ResponseOfDtoAgentStatusGet":{"required":["data"],"type":"object","properties":{"data":{"oneOf":[{"type":"null"},{"description":"Response data","$ref":"#/components/schemas/DtoAgentStatusGet"}]}}},"DtoAgentStatusGet":{"type":"object","properties":{"lastError":{"type":["null","string"],"description":"Date&Time of the last error occurred.","format":"date-time"},"lastUpdate":{"type":["null","string"],"description":"Date&Time of the last agent update occurred.","format":"date-time"},"lastStatus":{"type":["null","string"],"description":"Last known Agent status."},"url":{"type":["null","string"],"description":"The hostname or address for the agent. Can either be full URL https://example.org:1234 or hostname subdomain.example.org"},"httpPorts":{"type":["null","array"],"items":{"type":"string"},"description":"List of http ports the Agent listens to. If the Url is a full address (schema://hostname:port?) this can be ignored."},"httpsPorts":{"type":["null","array"],"items":{"type":"string"},"description":"List of https ports the Agent listens to. If the Url is a full address (schema://hostname:port?) this can be ignored."},"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Agent Identifier","format":"int64"},"name":{"type":["null","string"],"description":"Agent name"},"isGateway":{"type":"boolean","description":"If the agent is a Gateway Agent. If true, these Agents are the ones that should primarily be accessible from the internet."},"isCloudAgent":{"type":"boolean","description":"If the agent is a Cloud Agent. If true, the agent is managed by Frends."}}}}}}
```

## The ResponseOfDtoApiKeyGet object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ResponseOfDtoApiKeyGet":{"required":["data"],"type":"object","properties":{"data":{"oneOf":[{"type":"null"},{"description":"Response data","$ref":"#/components/schemas/DtoApiKeyGet"}]}}},"DtoApiKeyGet":{"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Unique identifier for the API key","format":"int64"},"value":{"type":"string","description":"Value of the API key","format":"uuid"},"modified":{"type":"string","description":"The date and time when the API key was last modified","format":"date-time"},"modifier":{"type":["null","string"],"description":"The user who last modified the API key"},"environment":{"description":"Environment of the API key","$ref":"#/components/schemas/DtoEnvironmentBase"},"name":{"type":["null","string"],"description":"Name of the API key"}}},"DtoEnvironmentBase":{"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Unique identifier for the Environment","format":"int64"},"displayName":{"type":["null","string"],"description":"Display name for the Environment"}}}}}}
```

## The ResponseOfDtoApiSpecification object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ResponseOfDtoApiSpecification":{"required":["data"],"type":"object","properties":{"data":{"oneOf":[{"type":"null"},{"description":"Response data","$ref":"#/components/schemas/DtoApiSpecification"}]}}},"DtoApiSpecification":{"required":["name"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Unique identifier for the API specification","format":"int64"},"name":{"type":"string","description":"Name of the API specification"},"activeVersion":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Currently active version of the API specification","format":"int32"},"description":{"type":["null","string"],"description":"Description for the API specification"}}}}}}
```

## The ResponseOfDtoCertificateDistributionResult object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ResponseOfDtoCertificateDistributionResult":{"required":["data"],"type":"object","properties":{"data":{"oneOf":[{"type":"null"},{"description":"Response data","$ref":"#/components/schemas/DtoCertificateDistributionResult"}]}}},"DtoCertificateDistributionResult":{"required":["sentToAgents","sentWithUnknownVersion","outdatedAgents","inactiveAgents"],"type":"object","properties":{"sentToAgents":{"type":"array","items":{"type":"string"},"description":"Agents whose configuration queue received the certificate"},"sentWithUnknownVersion":{"type":"array","items":{"type":"string"},"description":"Agents that received the certificate although their version is unknown"},"outdatedAgents":{"type":"array","items":{"type":"string"},"description":"Agents skipped because their version is too old for certificate distribution"},"inactiveAgents":{"type":"array","items":{"type":"string"},"description":"Agents skipped because they have not sent a heartbeat recently; they receive the certificate on their next synchronization if it is active and their version is 6.4 or later"}}}}}}
```

## The ResponseOfDtoCertificateGet object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ResponseOfDtoCertificateGet":{"required":["data"],"type":"object","properties":{"data":{"oneOf":[{"type":"null"},{"description":"Response data","$ref":"#/components/schemas/DtoCertificateGet"}]}}},"DtoCertificateGet":{"required":["certificateGuid","name","purpose","thumbprint","subject","issuer","notBeforeUtc","notAfterUtc","isActive","hasPrivateKey","source","managedByFrends","agentGroupName","agents","acmeOrderGuid"],"type":"object","properties":{"certificateGuid":{"type":"string","description":"Certificate unique identifier","format":"uuid"},"name":{"type":"string","description":"Stable certificate name; processes and triggers reference it as #cert.<name>. Uploading a new certificate under an existing name rotates it"},"purpose":{"description":"Certificate purpose: HttpsServer (agent HTTPS listener), ClientAuthentication (client certificate with private key) or ClientCertificateIssuer (trusted issuer for HTTP trigger client certificates)","$ref":"#/components/schemas/CertificatePurpose"},"thumbprint":{"type":"string","description":"Certificate thumbprint (SHA-1, uppercase hex)"},"subject":{"type":["null","string"],"description":"Certificate subject"},"issuer":{"type":["null","string"],"description":"Certificate issuer"},"notBeforeUtc":{"type":"string","description":"Validity start (UTC)","format":"date-time"},"notAfterUtc":{"type":"string","description":"Validity end (UTC)","format":"date-time"},"isActive":{"type":"boolean","description":"Whether this certificate is the active version of its name in its agent group"},"hasPrivateKey":{"type":"boolean","description":"Whether the stored certificate carries a private key (always true except for issuer certificates)"},"source":{"type":"string","description":"Certificate source (Manual or ACME)"},"managedByFrends":{"type":"boolean","description":"True when the certificate is an HTTPS certificate of a Frends-operated agent group and can only be changed by Frends operations"},"agentGroupName":{"type":"string","description":"Agent group name"},"agents":{"type":"array","items":{"$ref":"#/components/schemas/DtoCertificateAgentStatus"},"description":"Install status per agent in the certificate's agent group, as reported by agent heartbeats"},"acmeOrderGuid":{"type":["null","string"],"description":"Guid of the ACME order that issued this certificate (null for manually uploaded certificates). A renewal is issued by its own order","format":"uuid"}}},"CertificatePurpose":{"enum":["HttpsServer","ClientAuthentication","ClientCertificateIssuer"]},"DtoCertificateAgentStatus":{"required":["agentName","status","thumbprint","installedUtc","message","reportedUtc","served"],"type":"object","properties":{"agentName":{"type":"string","description":"Agent name"},"status":{"type":"string","description":"Installed | Failed | Missing | Unknown (reported by the agent for this certificate, or Unknown when agent status information is unavailable), OtherVersion (the agent holds another version of the same name), NotReported (the agent has not reported this certificate)"},"thumbprint":{"type":["null","string"],"description":"Thumbprint the agent reported for the name, when any"},"installedUtc":{"type":["null","string"],"description":"When the agent installed the reported version (UTC)","format":"date-time"},"message":{"type":["null","string"],"description":"Failure or explanation from the agent, when any"},"reportedUtc":{"type":["null","string"],"description":"Timestamp of the heartbeat the status comes from (UTC), when any","format":"date-time"},"served":{"type":"boolean","description":"True when the agent reports serving this certificate on its HTTPS listener"}}}}}}
```

## The ResponseOfDtoDataProtectionStatus object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ResponseOfDtoDataProtectionStatus":{"required":["data"],"type":"object","properties":{"data":{"oneOf":[{"type":"null"},{"description":"Response data","$ref":"#/components/schemas/DtoDataProtectionStatus"}]}}},"DtoDataProtectionStatus":{"required":["keyProtection","keyEncryptionCertificateThumbprint","keyEncryptionCertificateSource","keyEncryptionCertificateNotAfterUtc","previousKeyEncryptionCertificateThumbprints","keyRingEntries","keyRingCertificateThumbprints","unprotectedKeyRingEntries","certificatePrivateKeys","acmeAccountKeys","acmeExternalAccountBindingKeys","status","problems","warnings"],"type":"object","properties":{"keyProtection":{"type":"string","description":"Configured mode: None (plaintext) or Certificate"},"keyEncryptionCertificateThumbprint":{"type":["null","string"],"description":"Thumbprint of the current key-encryption certificate; null in None mode"},"keyEncryptionCertificateSource":{"type":["null","string"],"description":"Where the current key-encryption certificate was loaded from (store thumbprint, file or Key Vault secret)"},"keyEncryptionCertificateNotAfterUtc":{"type":["null","string"],"description":"Expiry of the current key-encryption certificate (UTC)","format":"date-time"},"previousKeyEncryptionCertificateThumbprints":{"type":"array","items":{"type":"string"},"description":"Thumbprints of the retired key-encryption certificates configured under Previous"},"keyRingEntries":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Number of Data Protection key-ring entries stored in the configuration database","format":"int32"},"keyRingCertificateThumbprints":{"type":"array","items":{"type":"string"},"description":"Thumbprints of every certificate that wraps a key-ring entry; all of them must travel with a database backup"},"unprotectedKeyRingEntries":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Key-ring entries stored without certificate wrapping (must be 0)","format":"int32"},"certificatePrivateKeys":{"description":"CERTIFICATE.CERTIFICATE_PFX rows","$ref":"#/components/schemas/DtoProtectedRowCounts"},"acmeAccountKeys":{"description":"ACME_ACCOUNT.ACCOUNT_KEY_PEM rows","$ref":"#/components/schemas/DtoProtectedRowCounts"},"acmeExternalAccountBindingKeys":{"description":"ACME_ACCOUNT.EAB_HMAC_KEY rows (accounts with an External Account Binding secret)","$ref":"#/components/schemas/DtoProtectedRowCounts"},"status":{"description":"Overall verdict, the same word /health reports: Unhealthy when Problems is non-empty, Degraded when only Warnings is, Healthy otherwise","$ref":"#/components/schemas/DataProtectionHealthStatus"},"problems":{"type":"array","items":{"type":"string"},"description":"Human-readable problems"},"warnings":{"type":"array","items":{"type":"string"},"description":"Conditions that need attention but do not stop the instance from working, such as rows still stored in plaintext in Certificate mode"}}},"DtoProtectedRowCounts":{"required":["encrypted","plaintext"],"type":"object","properties":{"encrypted":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Rows whose stored value carries the encryption marker","format":"int32"},"plaintext":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Rows still stored in plaintext","format":"int32"}}},"DataProtectionHealthStatus":{"enum":["Healthy","Degraded","Unhealthy"]}}}}
```

## The ResponseOfDtoEnvironmentGet object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ResponseOfDtoEnvironmentGet":{"required":["data"],"type":"object","properties":{"data":{"oneOf":[{"type":"null"},{"description":"Response data","$ref":"#/components/schemas/DtoEnvironmentGet"}]}}},"DtoEnvironmentGet":{"type":"object","properties":{"agentGroups":{"type":["null","array"],"items":{"$ref":"#/components/schemas/DtoAgentGroupGet"},"description":"The Agent Groups that belong to the Environment"},"internalName":{"type":["null","string"],"description":"Internal name used by Frends for the Environment"},"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Unique identifier for the Environment","format":"int64"},"displayName":{"type":["null","string"],"description":"Display name for the Environment"}}},"DtoAgentGroupGet":{"type":"object","properties":{"internalName":{"type":["null","string"],"description":"Internal name used by Frends for the Agent Group"},"agents":{"type":["null","array"],"items":{"type":"string"},"description":"The Agents that belong to the Agent Group"},"environment":{"description":"The Environment to which the Agent Group belongs","$ref":"#/components/schemas/DtoEnvironmentBase"},"agentDetails":{"type":["null","array"],"items":{"$ref":"#/components/schemas/DtoAgentGet"},"description":"Details about the Agents that belong to the Agent Group"},"agentRegistrationMode":{"description":"The registration mode that determines the lifecycle policy for agents in this group","$ref":"#/components/schemas/AgentRegistrationMode"},"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Unique identifier for the Agent Group","format":"int64"},"displayName":{"type":["null","string"],"description":"Display name for the Agent Group"}}},"DtoEnvironmentBase":{"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Unique identifier for the Environment","format":"int64"},"displayName":{"type":["null","string"],"description":"Display name for the Environment"}}},"DtoAgentGet":{"type":"object","properties":{"url":{"type":["null","string"],"description":"The hostname or address for the agent. Can either be full URL https://example.org:1234 or hostname subdomain.example.org"},"httpPorts":{"type":["null","array"],"items":{"type":"string"},"description":"List of http ports the Agent listens to. If the Url is a full address (schema://hostname:port?) this can be ignored."},"httpsPorts":{"type":["null","array"],"items":{"type":"string"},"description":"List of https ports the Agent listens to. If the Url is a full address (schema://hostname:port?) this can be ignored."},"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Agent Identifier","format":"int64"},"name":{"type":["null","string"],"description":"Agent name"},"isGateway":{"type":"boolean","description":"If the agent is a Gateway Agent. If true, these Agents are the ones that should primarily be accessible from the internet."},"isCloudAgent":{"type":"boolean","description":"If the agent is a Cloud Agent. If true, the agent is managed by Frends."}}},"AgentRegistrationMode":{"enum":["SelfHosted","Deployment","Cloud","StatefulSet"]}}}}
```

## The ResponseOfDtoEnvironmentVariableSchemaGet object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ResponseOfDtoEnvironmentVariableSchemaGet":{"required":["data"],"type":"object","properties":{"data":{"oneOf":[{"type":"null"},{"description":"Response data","$ref":"#/components/schemas/DtoEnvironmentVariableSchemaGet"}]}}},"DtoEnvironmentVariableSchemaGet":{"type":"object","properties":{"description":{"$ref":"#/components/schemas/JsonElement"},"childSchemas":{"type":"array","items":{"$ref":"#/components/schemas/DtoEnvironmentVariableSchemaBase"}},"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/EnvironmentVariableType"},"values":{"type":["null","array"],"items":{"$ref":"#/components/schemas/DtoEnvironmentVariableValue"}}}},"JsonElement":{},"DtoEnvironmentVariableSchemaBase":{"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"name":{"type":"string"},"type":{"$ref":"#/components/schemas/EnvironmentVariableType"},"values":{"type":["null","array"],"items":{"$ref":"#/components/schemas/DtoEnvironmentVariableValue"}}}},"EnvironmentVariableType":{"enum":["String","Object","Array","Secret","Number","Boolean"]},"DtoEnvironmentVariableValue":{"type":"object","properties":{"environment":{"$ref":"#/components/schemas/DtoEnvironmentBase"},"value":{"type":"array","items":{"type":"array","items":{"type":"array","items":{}}}},"modifiedUtc":{"type":"string","format":"date-time"},"modifier":{"type":"string"},"version":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"}}},"DtoEnvironmentBase":{"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Unique identifier for the Environment","format":"int64"},"displayName":{"type":["null","string"],"description":"Display name for the Environment"}}}}}}
```

## The ResponseOfDtoProcessDeploymentGet object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ResponseOfDtoProcessDeploymentGet":{"required":["data"],"type":"object","properties":{"data":{"oneOf":[{"type":"null"},{"description":"Response data","$ref":"#/components/schemas/DtoProcessDeploymentGet"}]}}},"DtoProcessDeploymentGet":{"required":["agentGroup","deploymentId","processId","processName","processGuid","processVersion","processBuildVersion","triggersActive"],"type":"object","properties":{"agentGroup":{"$ref":"#/components/schemas/DtoAgentGroupBase"},"deploymentId":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Unique identifier for the deployment.","format":"int64"},"processId":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Unique identifier for Process version.","format":"int64"},"processName":{"type":["null","string"],"description":"Process name"},"processGuid":{"type":"string","description":"Process unique identifier. This is shared between all versions of the Process.","format":"uuid"},"processVersion":{"type":["null","string"],"description":"Process version in the format X.Y.Z."},"processBuildVersion":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Process build version. This version is incremented by 1 on every successful Process build.","format":"int32"},"deployedAtUtc":{"type":["null","string"],"format":"date-time"},"deployedBy":{"type":["null","string"]},"description":{"type":["null","string"],"description":"Optional description for deployment"},"triggersActive":{"type":"boolean","description":"Are Process Triggers active"}}},"DtoAgentGroupBase":{"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Unique identifier for the Agent Group","format":"int64"},"displayName":{"type":["null","string"],"description":"Display name for the Agent Group"}}}}}}
```

## The ResponseOfDtoProcessGetAndProcessLinkModel object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ResponseOfDtoProcessGetAndProcessLinkModel":{"required":["links","data"],"type":"object","properties":{"links":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/ProcessLinkModel"}]},"data":{"oneOf":[{"type":"null"},{"description":"Response data","$ref":"#/components/schemas/DtoProcessGet"}]}}},"ProcessLinkModel":{"type":"object","properties":{"deployments":{"description":"Get all deployments for all versions of this Process","$ref":"#/components/schemas/LinkModel"},"delete":{"description":"Delete the process","$ref":"#/components/schemas/LinkModel"}}},"LinkModel":{"required":["uri","method"],"type":"object","properties":{"uri":{"type":"string","format":"uri"},"method":{"type":"string"}}},"DtoProcessGet":{"required":["name"],"type":"object","properties":{"bpmn":{"type":"string"},"elementParameters":{"type":"array","items":{"$ref":"#/components/schemas/ElementParameters"}},"manualTrigger":{"type":"array","items":{"type":"array","items":{}}},"obsoleteTasks":{"type":"array","items":{"$ref":"#/components/schemas/TaskSelectionData"}},"draftId":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int64"},"idOfBaseProcessForDraft":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int64"},"isDraft":{"type":"boolean"},"isSubprocess":{"type":"boolean"},"triggerData":{"type":["null","array"],"items":{"type":"array","items":{}}},"majorVersion":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"minorVersion":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"activateIfNew":{"type":"boolean"},"frendsVersion":{"type":["null","string"]},"ignoreDependencyConflicts":{"type":["null","boolean"]},"documentationMarkdown":{"type":["null","string"]},"targetFramework":{"type":"string"},"apiSpecId":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int64"},"isForMonitoringRule":{"type":"boolean"},"validationOnly":{"type":"boolean"},"cancellationDisabled":{"type":"boolean"},"preserveReferencesAtCheckpoint":{"type":"boolean"},"processVariables":{"type":["null","array"],"items":{"$ref":"#/components/schemas/ProcessVariable"}},"processTemplateId":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int64"},"processTemplateDeviated":{"type":["null","string"],"format":"date-time"},"nextProcessTemplate":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/ProcessTemplate"}]},"performAdditionalSyntaxValidation":{"type":"boolean"},"isDeleted":{"type":"boolean"},"version":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"uniqueIdentifier":{"type":"string","format":"uuid"},"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"name":{"type":"string"},"modified":{"type":"string","format":"date-time"},"modifier":{"type":["null","string"]},"description":{"type":["null","string"]},"isNotLatestVersion":{"type":"boolean"},"changeDescription":{"type":["null","string"]}}},"ElementParameters":{"type":"object","properties":{"id":{"type":["null","string"]},"type":{"$ref":"#/components/schemas/ElementType"},"parameters":{"type":["null","object"],"additionalProperties":{"type":"array","items":{"type":"array","items":{}}}},"selectedTypeId":{"type":["null","string"]},"promoteResultAs":{"type":["null","string"]},"name":{"type":["null","string"]},"description":{"type":["null","string"]},"isDefault":{"type":["null","boolean"]},"shouldRetry":{"type":["null","boolean"]},"maxRetryCount":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"},"shouldNotLogResult":{"type":["null","boolean"]},"shouldDispose":{"type":["null","boolean"]}}},"ElementType":{"enum":["Start","Task","Decision","SequenceFlow","ConditionBranch","Return","Throw","CallActivity","SubProcess","ParallelForeach","SequentialForeach","While","Expression","SubProcessStartNode","Catch","InclusiveGateway","InclusiveDecisionBranch","IntermediateReturn","GlobalErrorHandler","TestTask","SharedState","Dmn","DataObjectReference","DataStoreReference","HydrationPoint","ScheduledRehydration","SignalRehydration","NativeAi","Vdm"]},"TaskSelectionData":{"type":"object","properties":{"uri":{"type":"string"},"argumentsJson":{"type":["null","string"]},"returnType":{"type":["null","string"]},"name":{"type":"string"},"displayName":{"type":["null","string"]},"packageName":{"type":"string"},"description":{"type":["null","string"]},"isNotLatestVersion":{"type":"boolean"},"isStandard":{"type":"boolean"},"isDotNet":{"type":"boolean"}}},"ProcessVariable":{"type":"object","properties":{"name":{"type":["null","string"]},"value":{"type":["null","string"]},"isSecret":{"type":"boolean"},"mode":{"type":["null","string"]},"description":{"type":["null","string"]}}},"ProcessTemplate":{"required":["uniqueIdentifier","isListed","version","isDeleted","majorVersion","minorVersion","name","modifier","modified","targetFramework","frendsVersion","isSubProcess","staticRequiredEnvironmentVariablesJson","staticRequiredCertificatesJson","allowedMcpToolsJson"],"type":"object","properties":{"uniqueIdentifier":{"type":"string","format":"uuid"},"isListed":{"type":"boolean"},"version":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"isDeleted":{"type":"boolean"},"processVariablesJson":{"maxLength":2147483647,"type":["null","string"]},"processTags":{"maxLength":2147483647,"type":["null","string"]},"documentation":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/ProcessDocumentation"}]},"getVersion":{"pattern":"^\\d+(\\.\\d+){1,3}$","type":["null","string"]},"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"majorVersion":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"minorVersion":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"name":{"maxLength":512,"minLength":0,"type":"string"},"modifier":{"maxLength":256,"minLength":0,"type":"string"},"modified":{"type":"string","format":"date-time"},"targetFramework":{"maxLength":32,"minLength":0,"type":"string"},"frendsVersion":{"maxLength":64,"minLength":0,"type":"string"},"isSubProcess":{"type":"boolean"},"staticRequiredEnvironmentVariablesJson":{"maxLength":2147483647,"type":"string"},"staticRequiredCertificatesJson":{"maxLength":2147483647,"type":"string"},"description":{"maxLength":2147483647,"minLength":0,"type":["null","string"]},"changeDescription":{"maxLength":2147483647,"minLength":0,"type":["null","string"]},"bpmn":{"maxLength":2147483647,"minLength":0,"type":["null","string"]},"isForMonitoringRule":{"type":["null","boolean"]},"cancellationDisabled":{"type":["null","boolean"]},"elementParameters":{"maxLength":2147483647,"minLength":0,"type":["null","string"]},"promotedResultVariablesJson":{"maxLength":2147483647,"minLength":0,"type":["null","string"]},"usedSubprocessesJson":{"maxLength":2147483647,"minLength":0,"type":["null","string"]},"usedTasksJson":{"maxLength":2147483647,"minLength":0,"type":["null","string"]},"triggersJson":{"maxLength":2147483647,"minLength":0,"type":["null","string"]},"manualTriggerJson":{"maxLength":2147483647,"minLength":0,"type":["null","string"]},"allowedMcpToolsJson":{"maxLength":2147483647,"minLength":0,"type":"string"},"preserveReferencesAtCheckpoint":{"type":"boolean"}}},"ProcessDocumentation":{"required":["uniqueIdentifier","documentationMarkdown","modifier","majorVersion","minorVersion"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"uniqueIdentifier":{"type":"string","format":"uuid"},"documentationMarkdown":{"maxLength":2147483647,"type":"string"},"modifier":{"maxLength":256,"type":"string"},"majorVersion":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"minorVersion":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"modifiedUtc":{"type":"string","format":"date-time"}}}}}}
```

## The ResponseOfFindEffectiveApiPolicyViewModel object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ResponseOfFindEffectiveApiPolicyViewModel":{"required":["data"],"type":"object","properties":{"data":{"oneOf":[{"type":"null"},{"description":"Response data","$ref":"#/components/schemas/FindEffectiveApiPolicyViewModel"}]}}},"FindEffectiveApiPolicyViewModel":{"required":["policy","endpoint"],"type":"object","properties":{"policy":{"$ref":"#/components/schemas/ApiPolicy"},"endpoint":{"$ref":"#/components/schemas/ApiPolicyTargetEndpoint"}}},"ApiPolicy":{"required":["uniqueIdentifier","name","modifier","apiKeyName","apiKeyLocation"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"uniqueIdentifier":{"type":"string","format":"uuid"},"name":{"type":"string"},"deletedUtc":{"type":["null","string"],"format":"date-time"},"description":{"type":["null","string"]},"modifier":{"type":"string"},"modifiedUtc":{"type":"string","format":"date-time"},"allowPublicAccess":{"type":"boolean"},"apiKeyName":{"type":"string"},"apiKeyLocation":{"$ref":"#/components/schemas/ParameterLocation"},"targetEndpoints":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyTargetEndpoint"}},"identities":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyIdentity"}},"apiKeyGroups":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyApiKeyGroup"}},"requestLoggings":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyRequestLogging"}}}},"ParameterLocation":{"enum":["Query","Header","Path","Cookie"]},"ApiPolicyTargetEndpoint":{"required":["apiPolicy","path"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"apiPolicy":{"$ref":"#/components/schemas/ApiPolicy"},"path":{"type":"string"},"method":{"$ref":"#/components/schemas/PolicyEndpointMethod"},"requestLimit":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"},"requestLimitWindowInMinutes":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"}}},"PolicyEndpointMethod":{"enum":["All","Get","Post","Put","Head","Delete","Patch","Options","Connect","Trace"]},"ApiPolicyIdentity":{"required":["apiPolicy"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"apiPolicy":{"$ref":"#/components/schemas/ApiPolicy"},"isPrivateApplication":{"type":"boolean"},"issuersJson":{"type":"string"},"name":{"type":"string"},"throttlingByClaim":{"type":["null","string"]},"priorityNumber":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"identityRules":{"type":["null","array"],"items":{"$ref":"#/components/schemas/ApiPolicyIdentityRule"}},"deployments":{},"requestLimit":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"},"requestLimitWindowInMinutes":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"}}},"ApiPolicyIdentityRule":{"required":["identity"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"identity":{"$ref":"#/components/schemas/ApiPolicyIdentity"},"ruleType":{"$ref":"#/components/schemas/ApiAccessRuleType"},"claim":{"type":"string"},"value":{"type":"string"},"matchType":{"$ref":"#/components/schemas/IdentityRuleMatchType"}}},"ApiAccessRuleType":{"enum":["Allow","Deny"]},"IdentityRuleMatchType":{"enum":["Exact","Exists","Regex"]},"ApiPolicyApiKeyGroup":{"required":["apiPolicy","name"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"apiPolicy":{"$ref":"#/components/schemas/ApiPolicy"},"name":{"type":"string"},"keyGroupAssignments":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyApiKeyGroupAssignment"}},"requestLimit":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"},"requestLimitWindowInMinutes":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"}}},"ApiPolicyApiKeyGroupAssignment":{"required":["apiKey","apiKeyGroup"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"apiKey":{"$ref":"#/components/schemas/ApiKey"},"apiKeyGroup":{"$ref":"#/components/schemas/ApiPolicyApiKeyGroup"}}},"ApiKey":{"required":["name","environment","modifier"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"name":{"type":"string"},"value":{"type":"string","format":"uuid"},"environment":{"type":"string"},"modified":{"type":"string","format":"date-time"},"modifier":{"type":"string"},"groupAssignments":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyApiKeyGroupAssignment"}}}},"ApiPolicyRequestLogging":{"required":["name","apiPolicy","loggingFieldsJson","ipLogging"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"name":{"type":"string"},"apiPolicy":{"$ref":"#/components/schemas/ApiPolicy"},"loggingFieldsJson":{"type":"string"},"ipLogging":{"$ref":"#/components/schemas/IpLoggingType"},"requestBodyMaxLengthKb":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"responseBodyMaxLengthKb":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"disableLogging":{"type":"boolean"},"deployments":{"type":"array","items":{"$ref":"#/components/schemas/ApiPolicyRequestLoggingDeployment"}}}},"IpLoggingType":{"enum":["ClientIP","ClientIPXForwardedForFirst","ClientIPXForwardedForAll","Disable"]},"ApiPolicyRequestLoggingDeployment":{"required":["apiPolicyRequestLogging","agentGroupName","deployer"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"apiPolicyRequestLogging":{"$ref":"#/components/schemas/ApiPolicyRequestLogging"},"agentGroupName":{"type":"string"},"deployer":{"type":"string"},"deployedUtc":{"type":"string","format":"date-time"}}}}}}
```

## The ResponseOfIEnumerableOfApiPolicyListItemViewModel object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ResponseOfIEnumerableOfApiPolicyListItemViewModel":{"required":["data"],"type":"object","properties":{"data":{"type":["null","array"],"items":{"$ref":"#/components/schemas/ApiPolicyListItemViewModel"},"description":"Response data"}}},"ApiPolicyListItemViewModel":{"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"The unique identifier of the API policy","format":"int64"},"name":{"type":"string","description":"The name of the policy"},"description":{"type":["null","string"],"description":"The description of the policy"}}}}}}
```

## The ResponseOfIListOfApiPassthroughViewModel object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ResponseOfIListOfApiPassthroughViewModel":{"required":["data"],"type":"object","properties":{"data":{"type":["null","array"],"items":{"$ref":"#/components/schemas/ApiPassthroughViewModel"},"description":"Response data"}}},"ApiPassthroughViewModel":{"required":["id","apiVersionId","modifier","modified","path","method","isDefault","corsEnabled","targetUrl","headers","allowedOrigins"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Unique identifier of the passthrough configuration","format":"int64"},"apiVersionId":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Unique identifier of the API version","format":"int64"},"modifier":{"type":"string","description":"User who last modified the configuration"},"modified":{"type":"string","description":"Time when configuration was last modified","format":"date-time"},"path":{"type":["null","string"],"description":"Source API path for this passthrough configuration. Not used when IsDefault is set to true."},"method":{"type":["null","string"],"description":"HTTP method. Not used when IsDefault is set to true."},"isDefault":{"type":"boolean","description":"Is this configuration used for all paths and HTTP methods"},"corsEnabled":{"type":"boolean","description":"Is CORS enabled"},"targetUrl":{"description":"Target URL","$ref":"#/components/schemas/ApiPassthroughTarget"},"headers":{"type":["null","array"],"items":{"$ref":"#/components/schemas/ApiPassthroughHeader"},"description":"Header definitions"},"allowedOrigins":{"type":["null","array"],"items":{"type":"string"},"description":"Allowed origins. Used when CORS is enabled."}}},"ApiPassthroughTarget":{"required":["server","basePath","operationPath","query"],"type":"object","properties":{"server":{"type":"string","description":"Server part of the target URL"},"basePath":{"type":"string","description":"Base path of the target URL"},"operationPath":{"type":["null","string"],"description":"Operation path of the target URL"},"query":{"type":["null","string"],"description":"Query parameters of the target URL"}}},"ApiPassthroughHeader":{"required":["action","name","value"],"type":"object","properties":{"action":{"type":"string","description":"Header action (Add, Overwrite, Remove)"},"name":{"type":"string","description":"Header name"},"value":{"type":"string","description":"Header value"}}}}}}
```

## The ResponseOfIListOfDtoAgentGroupGet object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ResponseOfIListOfDtoAgentGroupGet":{"required":["data"],"type":"object","properties":{"data":{"type":["null","array"],"items":{"$ref":"#/components/schemas/DtoAgentGroupGet"},"description":"Response data"}}},"DtoAgentGroupGet":{"type":"object","properties":{"internalName":{"type":["null","string"],"description":"Internal name used by Frends for the Agent Group"},"agents":{"type":["null","array"],"items":{"type":"string"},"description":"The Agents that belong to the Agent Group"},"environment":{"description":"The Environment to which the Agent Group belongs","$ref":"#/components/schemas/DtoEnvironmentBase"},"agentDetails":{"type":["null","array"],"items":{"$ref":"#/components/schemas/DtoAgentGet"},"description":"Details about the Agents that belong to the Agent Group"},"agentRegistrationMode":{"description":"The registration mode that determines the lifecycle policy for agents in this group","$ref":"#/components/schemas/AgentRegistrationMode"},"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Unique identifier for the Agent Group","format":"int64"},"displayName":{"type":["null","string"],"description":"Display name for the Agent Group"}}},"DtoEnvironmentBase":{"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Unique identifier for the Environment","format":"int64"},"displayName":{"type":["null","string"],"description":"Display name for the Environment"}}},"DtoAgentGet":{"type":"object","properties":{"url":{"type":["null","string"],"description":"The hostname or address for the agent. Can either be full URL https://example.org:1234 or hostname subdomain.example.org"},"httpPorts":{"type":["null","array"],"items":{"type":"string"},"description":"List of http ports the Agent listens to. If the Url is a full address (schema://hostname:port?) this can be ignored."},"httpsPorts":{"type":["null","array"],"items":{"type":"string"},"description":"List of https ports the Agent listens to. If the Url is a full address (schema://hostname:port?) this can be ignored."},"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Agent Identifier","format":"int64"},"name":{"type":["null","string"],"description":"Agent name"},"isGateway":{"type":"boolean","description":"If the agent is a Gateway Agent. If true, these Agents are the ones that should primarily be accessible from the internet."},"isCloudAgent":{"type":"boolean","description":"If the agent is a Cloud Agent. If true, the agent is managed by Frends."}}},"AgentRegistrationMode":{"enum":["SelfHosted","Deployment","Cloud","StatefulSet"]}}}}
```

## The ResponseOfIListOfDtoEnvironmentGet object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ResponseOfIListOfDtoEnvironmentGet":{"required":["data"],"type":"object","properties":{"data":{"type":["null","array"],"items":{"$ref":"#/components/schemas/DtoEnvironmentGet"},"description":"Response data"}}},"DtoEnvironmentGet":{"type":"object","properties":{"agentGroups":{"type":["null","array"],"items":{"$ref":"#/components/schemas/DtoAgentGroupGet"},"description":"The Agent Groups that belong to the Environment"},"internalName":{"type":["null","string"],"description":"Internal name used by Frends for the Environment"},"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Unique identifier for the Environment","format":"int64"},"displayName":{"type":["null","string"],"description":"Display name for the Environment"}}},"DtoAgentGroupGet":{"type":"object","properties":{"internalName":{"type":["null","string"],"description":"Internal name used by Frends for the Agent Group"},"agents":{"type":["null","array"],"items":{"type":"string"},"description":"The Agents that belong to the Agent Group"},"environment":{"description":"The Environment to which the Agent Group belongs","$ref":"#/components/schemas/DtoEnvironmentBase"},"agentDetails":{"type":["null","array"],"items":{"$ref":"#/components/schemas/DtoAgentGet"},"description":"Details about the Agents that belong to the Agent Group"},"agentRegistrationMode":{"description":"The registration mode that determines the lifecycle policy for agents in this group","$ref":"#/components/schemas/AgentRegistrationMode"},"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Unique identifier for the Agent Group","format":"int64"},"displayName":{"type":["null","string"],"description":"Display name for the Agent Group"}}},"DtoEnvironmentBase":{"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Unique identifier for the Environment","format":"int64"},"displayName":{"type":["null","string"],"description":"Display name for the Environment"}}},"DtoAgentGet":{"type":"object","properties":{"url":{"type":["null","string"],"description":"The hostname or address for the agent. Can either be full URL https://example.org:1234 or hostname subdomain.example.org"},"httpPorts":{"type":["null","array"],"items":{"type":"string"},"description":"List of http ports the Agent listens to. If the Url is a full address (schema://hostname:port?) this can be ignored."},"httpsPorts":{"type":["null","array"],"items":{"type":"string"},"description":"List of https ports the Agent listens to. If the Url is a full address (schema://hostname:port?) this can be ignored."},"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Agent Identifier","format":"int64"},"name":{"type":["null","string"],"description":"Agent name"},"isGateway":{"type":"boolean","description":"If the agent is a Gateway Agent. If true, these Agents are the ones that should primarily be accessible from the internet."},"isCloudAgent":{"type":"boolean","description":"If the agent is a Cloud Agent. If true, the agent is managed by Frends."}}},"AgentRegistrationMode":{"enum":["SelfHosted","Deployment","Cloud","StatefulSet"]}}}}
```

## The ResponseOfImportResult object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ResponseOfImportResult":{"required":["data"],"type":"object","properties":{"data":{"oneOf":[{"type":"null"},{"description":"Response data","$ref":"#/components/schemas/ImportResult"}]}}},"ImportResult":{"required":["name","resourceLocation"],"type":"object","properties":{"name":{"type":"string"},"elementIdentifier":{"type":"string","format":"uuid"},"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"resourceLocation":{"type":"string","format":"uri"},"version":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"}}}}}}
```

## The ResponseOfint object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ResponseOfint":{"required":["data"],"type":"object","properties":{"data":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Response data","format":"int32"}}}}}}
```

## The ResponseOfListOfAcmeProviderInfo object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ResponseOfListOfAcmeProviderInfo":{"required":["data"],"type":"object","properties":{"data":{"type":["null","array"],"items":{"$ref":"#/components/schemas/AcmeProviderInfo"},"description":"Response data"}}},"AcmeProviderInfo":{"required":["name","directoryUrl","requiresExternalAccountBinding"],"type":"object","properties":{"name":{"type":"string","description":"Provider name"},"directoryUrl":{"type":"string","description":"ACME directory URL"},"requiresExternalAccountBinding":{"type":"boolean","description":"Whether this provider requires external account binding (EAB)"},"issuerDomainName":{"type":["null","string"],"description":"Issuer domain name for the dns-persist-01 challenge's TXT record value; null when this provider doesn't offer the challenge type"}}}}}}
```

## The ResponseOfListOfDtoAcmeAccountGet object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ResponseOfListOfDtoAcmeAccountGet":{"required":["data"],"type":"object","properties":{"data":{"type":["null","array"],"items":{"$ref":"#/components/schemas/DtoAcmeAccountGet"},"description":"Response data"}}},"DtoAcmeAccountGet":{"required":["accountGuid","provider","acmeDirectoryUrl","email","accountUri","hasExternalAccountBinding","managedByFrends","createdUtc"],"type":"object","properties":{"accountGuid":{"type":"string","description":"Account unique identifier","format":"uuid"},"provider":{"type":"string","description":"Provider name"},"acmeDirectoryUrl":{"type":"string","description":"ACME directory URL"},"email":{"type":["null","string"],"description":"Optional contact email for the ACME account"},"accountUri":{"type":["null","string"],"description":"ACME account URI as returned by the ACME server"},"hasExternalAccountBinding":{"type":"boolean","description":"Whether this account was created with external account binding (EAB)"},"managedByFrends":{"type":"boolean","description":"Whether the account is managed by Frends operations (only the FrendsOps role can create or delete it)"},"createdUtc":{"type":"string","description":"Creation timestamp (UTC)","format":"date-time"}}}}}}
```

## The ResponseOfListOfDtoAcmeOrderGet object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ResponseOfListOfDtoAcmeOrderGet":{"required":["data"],"type":"object","properties":{"data":{"type":["null","array"],"items":{"$ref":"#/components/schemas/DtoAcmeOrderGet"},"description":"Response data"}}},"DtoAcmeOrderGet":{"required":["orderGuid","domain","certificateName","challengeType","status","dnsTxtRecordName","dnsTxtValue","lastError","agentGroupName","managedByFrends","certificateGuid","createdUtc","expiresUtc","completedUtc"],"type":"object","properties":{"orderGuid":{"type":"string","description":"Order unique identifier","format":"uuid"},"domain":{"type":"string","description":"Domain name the order is for"},"certificateName":{"type":"string","description":"Name of the certificate the order issues; renewals reuse it"},"challengeType":{"type":"string","description":"Challenge type used for this order"},"status":{"type":"string","description":"Order status, normalized to RFC 8555 lowercase (pending/ready/processing/valid/invalid), or revoked once the issued certificate has been revoked at the CA"},"dnsTxtRecordName":{"type":["null","string"],"description":"DNS TXT record name to create for the dns-01 or dns-persist-01 challenge; null for http-01"},"dnsTxtValue":{"type":["null","string"],"description":"DNS TXT record value to create for the dns-01 or dns-persist-01 challenge; null for http-01"},"lastError":{"type":["null","string"],"description":"Last error encountered while processing the order, if any"},"agentGroupName":{"type":"string","description":"Agent group name the order belongs to"},"managedByFrends":{"type":"boolean","description":"True when the agent group is operated by Frends: only the FrendsOps role can create, validate or finalize the order"},"certificateGuid":{"type":["null","string"],"description":"Certificate unique identifier, set once the order has been finalized","format":"uuid"},"createdUtc":{"type":"string","description":"Creation timestamp (UTC)","format":"date-time"},"expiresUtc":{"type":["null","string"],"description":"Order expiry timestamp (UTC), if known","format":"date-time"},"completedUtc":{"type":["null","string"],"description":"Completion timestamp (UTC), set once finalized","format":"date-time"},"revokedUtc":{"type":["null","string"],"description":"Revocation timestamp (UTC), set once the issued certificate has been revoked at the CA","format":"date-time"},"revocationReason":{"type":["null","string"],"description":"Revocation reason given to the CA, set together with RevokedUtc"}}}}}}
```

## The ResponseOfListOfDtoCertificateGet object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ResponseOfListOfDtoCertificateGet":{"required":["data"],"type":"object","properties":{"data":{"type":["null","array"],"items":{"$ref":"#/components/schemas/DtoCertificateGet"},"description":"Response data"}}},"DtoCertificateGet":{"required":["certificateGuid","name","purpose","thumbprint","subject","issuer","notBeforeUtc","notAfterUtc","isActive","hasPrivateKey","source","managedByFrends","agentGroupName","agents","acmeOrderGuid"],"type":"object","properties":{"certificateGuid":{"type":"string","description":"Certificate unique identifier","format":"uuid"},"name":{"type":"string","description":"Stable certificate name; processes and triggers reference it as #cert.<name>. Uploading a new certificate under an existing name rotates it"},"purpose":{"description":"Certificate purpose: HttpsServer (agent HTTPS listener), ClientAuthentication (client certificate with private key) or ClientCertificateIssuer (trusted issuer for HTTP trigger client certificates)","$ref":"#/components/schemas/CertificatePurpose"},"thumbprint":{"type":"string","description":"Certificate thumbprint (SHA-1, uppercase hex)"},"subject":{"type":["null","string"],"description":"Certificate subject"},"issuer":{"type":["null","string"],"description":"Certificate issuer"},"notBeforeUtc":{"type":"string","description":"Validity start (UTC)","format":"date-time"},"notAfterUtc":{"type":"string","description":"Validity end (UTC)","format":"date-time"},"isActive":{"type":"boolean","description":"Whether this certificate is the active version of its name in its agent group"},"hasPrivateKey":{"type":"boolean","description":"Whether the stored certificate carries a private key (always true except for issuer certificates)"},"source":{"type":"string","description":"Certificate source (Manual or ACME)"},"managedByFrends":{"type":"boolean","description":"True when the certificate is an HTTPS certificate of a Frends-operated agent group and can only be changed by Frends operations"},"agentGroupName":{"type":"string","description":"Agent group name"},"agents":{"type":"array","items":{"$ref":"#/components/schemas/DtoCertificateAgentStatus"},"description":"Install status per agent in the certificate's agent group, as reported by agent heartbeats"},"acmeOrderGuid":{"type":["null","string"],"description":"Guid of the ACME order that issued this certificate (null for manually uploaded certificates). A renewal is issued by its own order","format":"uuid"}}},"CertificatePurpose":{"enum":["HttpsServer","ClientAuthentication","ClientCertificateIssuer"]},"DtoCertificateAgentStatus":{"required":["agentName","status","thumbprint","installedUtc","message","reportedUtc","served"],"type":"object","properties":{"agentName":{"type":"string","description":"Agent name"},"status":{"type":"string","description":"Installed | Failed | Missing | Unknown (reported by the agent for this certificate, or Unknown when agent status information is unavailable), OtherVersion (the agent holds another version of the same name), NotReported (the agent has not reported this certificate)"},"thumbprint":{"type":["null","string"],"description":"Thumbprint the agent reported for the name, when any"},"installedUtc":{"type":["null","string"],"description":"When the agent installed the reported version (UTC)","format":"date-time"},"message":{"type":["null","string"],"description":"Failure or explanation from the agent, when any"},"reportedUtc":{"type":["null","string"],"description":"Timestamp of the heartbeat the status comes from (UTC), when any","format":"date-time"},"served":{"type":"boolean","description":"True when the agent reports serving this certificate on its HTTPS listener"}}}}}}
```

## The ResponseOfListOfDtoCertificateUsage object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ResponseOfListOfDtoCertificateUsage":{"required":["data"],"type":"object","properties":{"data":{"type":["null","array"],"items":{"$ref":"#/components/schemas/DtoCertificateUsage"},"description":"Response data"}}},"DtoCertificateUsage":{"required":["processGuid","processName","version","agentGroupName","environment","kind"],"type":"object","properties":{"processGuid":{"type":"string","description":"Process guid","format":"uuid"},"processName":{"type":"string","description":"Process name"},"version":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Deployed process version","format":"int32"},"agentGroupName":{"type":"string","description":"Agent group the version is deployed to"},"environment":{"type":"string","description":"Environment of the deployment"},"kind":{"type":"string","description":"ProcessReference (a step or trigger uses #cert.<name>), ProcessVariableReference (a process variable of this agent group uses #cert.<name>) or HttpTriggerCertificateAuthentication (an HTTP trigger authenticates callers by client certificate, which relies on the group's issuer certificates)"}}}}}}
```

## The ResponseOfListOfDtoProcessDeploymentGet object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ResponseOfListOfDtoProcessDeploymentGet":{"required":["data"],"type":"object","properties":{"data":{"type":["null","array"],"items":{"$ref":"#/components/schemas/DtoProcessDeploymentGet"},"description":"Response data"}}},"DtoProcessDeploymentGet":{"required":["agentGroup","deploymentId","processId","processName","processGuid","processVersion","processBuildVersion","triggersActive"],"type":"object","properties":{"agentGroup":{"$ref":"#/components/schemas/DtoAgentGroupBase"},"deploymentId":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Unique identifier for the deployment.","format":"int64"},"processId":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Unique identifier for Process version.","format":"int64"},"processName":{"type":["null","string"],"description":"Process name"},"processGuid":{"type":"string","description":"Process unique identifier. This is shared between all versions of the Process.","format":"uuid"},"processVersion":{"type":["null","string"],"description":"Process version in the format X.Y.Z."},"processBuildVersion":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Process build version. This version is incremented by 1 on every successful Process build.","format":"int32"},"deployedAtUtc":{"type":["null","string"],"format":"date-time"},"deployedBy":{"type":["null","string"]},"description":{"type":["null","string"],"description":"Optional description for deployment"},"triggersActive":{"type":"boolean","description":"Are Process Triggers active"}}},"DtoAgentGroupBase":{"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Unique identifier for the Agent Group","format":"int64"},"displayName":{"type":["null","string"],"description":"Display name for the Agent Group"}}}}}}
```

## The ResponseOfListOfPrivateApplicationViewModel object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ResponseOfListOfPrivateApplicationViewModel":{"required":["data"],"type":"object","properties":{"data":{"type":["null","array"],"items":{"$ref":"#/components/schemas/PrivateApplicationViewModel"},"description":"Response data"}}},"PrivateApplicationViewModel":{"required":["id","modifier","modifiedUtc","hasTokens","hasActiveTokens","nextTokenExpiry","name","description","defaultTokenLifetimeDays","customTokenClaims","tags"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Id of the application","format":"int64"},"modifier":{"type":"string","description":"Modifier of the application"},"modifiedUtc":{"type":"string","description":"Last modified date of the application","format":"date-time"},"hasTokens":{"type":"boolean","description":"Indicates if the application contains tokens"},"hasActiveTokens":{"type":"boolean","description":"Indicates if the application contains not revoked tokens"},"nextTokenExpiry":{"type":["null","string"],"description":"Next token expiry date","format":"date-time"},"name":{"type":"string","description":"Name of the application"},"description":{"type":["null","string"],"description":"Description of the application"},"defaultTokenLifetimeDays":{"maximum":730,"minimum":1,"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Default token lifetime in days","format":"int32"},"customTokenClaims":{"description":"Custom token claims","$ref":"#/components/schemas/JsonObject"},"tags":{"type":"array","items":{"type":"string"},"description":"Tags for the application"}}},"JsonObject":{"type":"object"}}}}
```

## The ResponseOflong object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ResponseOflong":{"required":["data"],"type":"object","properties":{"data":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Response data","format":"int64"}}}}}}
```

## The ResponseOfPrivateApplicationTokensResponse object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ResponseOfPrivateApplicationTokensResponse":{"required":["data"],"type":"object","properties":{"data":{"oneOf":[{"type":"null"},{"description":"Response data","$ref":"#/components/schemas/PrivateApplicationTokensResponse"}]}}},"PrivateApplicationTokensResponse":{"required":["tokens"],"type":"object","properties":{"tokenCount":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"tokens":{"type":"array","items":{"$ref":"#/components/schemas/PrivateApplicationTokenViewModel"}}}},"PrivateApplicationTokenViewModel":{"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Id of the token","format":"int64"},"name":{"type":"string","description":"Name of the token"},"expiryTimeUtc":{"type":"string","description":"Expiry time of the token","format":"date-time"},"createTimeUtc":{"type":"string","description":"Create time of the token","format":"date-time"},"tokenClaims":{"description":"Token claims","$ref":"#/components/schemas/JsonObject"},"creator":{"type":"string","description":"Creator of the token"},"revoker":{"type":["null","string"],"description":"Revoker of the token"},"revokeTimeUtc":{"type":["null","string"],"description":"Revoked time of the token","format":"date-time"},"revokeReason":{"type":["null","string"],"description":"Reason for revoking the token"},"fullToken":{"type":"string","description":"Raw token"},"payloadOnly":{"type":"string","description":"Only payload part of the token"}}},"JsonObject":{"type":"object"}}}}
```

## The ResponseOfPrivateApplicationTokenViewModel object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ResponseOfPrivateApplicationTokenViewModel":{"required":["data"],"type":"object","properties":{"data":{"oneOf":[{"type":"null"},{"description":"Response data","$ref":"#/components/schemas/PrivateApplicationTokenViewModel"}]}}},"PrivateApplicationTokenViewModel":{"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Id of the token","format":"int64"},"name":{"type":"string","description":"Name of the token"},"expiryTimeUtc":{"type":"string","description":"Expiry time of the token","format":"date-time"},"createTimeUtc":{"type":"string","description":"Create time of the token","format":"date-time"},"tokenClaims":{"description":"Token claims","$ref":"#/components/schemas/JsonObject"},"creator":{"type":"string","description":"Creator of the token"},"revoker":{"type":["null","string"],"description":"Revoker of the token"},"revokeTimeUtc":{"type":["null","string"],"description":"Revoked time of the token","format":"date-time"},"revokeReason":{"type":["null","string"],"description":"Reason for revoking the token"},"fullToken":{"type":"string","description":"Raw token"},"payloadOnly":{"type":"string","description":"Only payload part of the token"}}},"JsonObject":{"type":"object"}}}}
```

## The ResponseOfPrivateApplicationViewModel object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ResponseOfPrivateApplicationViewModel":{"required":["data"],"type":"object","properties":{"data":{"oneOf":[{"type":"null"},{"description":"Response data","$ref":"#/components/schemas/PrivateApplicationViewModel"}]}}},"PrivateApplicationViewModel":{"required":["id","modifier","modifiedUtc","hasTokens","hasActiveTokens","nextTokenExpiry","name","description","defaultTokenLifetimeDays","customTokenClaims","tags"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Id of the application","format":"int64"},"modifier":{"type":"string","description":"Modifier of the application"},"modifiedUtc":{"type":"string","description":"Last modified date of the application","format":"date-time"},"hasTokens":{"type":"boolean","description":"Indicates if the application contains tokens"},"hasActiveTokens":{"type":"boolean","description":"Indicates if the application contains not revoked tokens"},"nextTokenExpiry":{"type":["null","string"],"description":"Next token expiry date","format":"date-time"},"name":{"type":"string","description":"Name of the application"},"description":{"type":["null","string"],"description":"Description of the application"},"defaultTokenLifetimeDays":{"maximum":730,"minimum":1,"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"description":"Default token lifetime in days","format":"int32"},"customTokenClaims":{"description":"Custom token claims","$ref":"#/components/schemas/JsonObject"},"tags":{"type":"array","items":{"type":"string"},"description":"Tags for the application"}}},"JsonObject":{"type":"object"}}}}
```

## The ResponseOfProcessCountsByAgentGroupAndProcessAndDateTime object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ResponseOfProcessCountsByAgentGroupAndProcessAndDateTime":{"required":["data"],"type":"object","properties":{"data":{"oneOf":[{"type":"null"},{"description":"Response data","$ref":"#/components/schemas/ProcessCountsByAgentGroupAndProcessAndDateTime"}]}}},"ProcessCountsByAgentGroupAndProcessAndDateTime":{"required":["executionCounts"],"type":"object","properties":{"executionCounts":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ProcessInstanceExecutionCounts"}}}}}},"ProcessInstanceExecutionCounts":{"type":"object","properties":{"running":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"},"latestRunning":{"type":["null","string"],"format":"date-time"},"successful":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"},"latestSuccessful":{"type":["null","string"],"format":"date-time"},"failed":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"},"latestFailed":{"type":["null","string"],"format":"date-time"},"erroredNotAcknowledged":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"},"latestExecutionState":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/ExecutionState"}]}}},"ExecutionState":{"enum":["Ok","Waiting","Launched","Starting","Started","Canceled","CanceledByTerminate","FinishedAsZombie","TerminatedByUser","ActionSkipped","Failed","Exception","Finished"]}}}}
```

## The ResponseOfProcessDataModel object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ResponseOfProcessDataModel":{"required":["data"],"type":"object","properties":{"data":{"oneOf":[{"type":"null"},{"description":"Response data","$ref":"#/components/schemas/ProcessDataModel"}]}}},"ProcessDataModel":{"required":["name"],"type":"object","properties":{"bpmn":{"type":"string"},"elementParameters":{"type":"array","items":{"$ref":"#/components/schemas/ElementParameters"}},"manualTrigger":{"type":"array","items":{"type":"array","items":{}}},"obsoleteTasks":{"type":"array","items":{"$ref":"#/components/schemas/TaskSelectionData"}},"draftId":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int64"},"idOfBaseProcessForDraft":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int64"},"isDraft":{"type":"boolean"},"isSubprocess":{"type":"boolean"},"triggerData":{"type":["null","array"],"items":{"type":"array","items":{}}},"majorVersion":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"minorVersion":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"activateIfNew":{"type":"boolean"},"frendsVersion":{"type":["null","string"]},"ignoreDependencyConflicts":{"type":["null","boolean"]},"documentationMarkdown":{"type":["null","string"]},"targetFramework":{"type":"string"},"apiSpecId":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int64"},"isForMonitoringRule":{"type":"boolean"},"validationOnly":{"type":"boolean"},"cancellationDisabled":{"type":"boolean"},"preserveReferencesAtCheckpoint":{"type":"boolean"},"processVariables":{"type":["null","array"],"items":{"$ref":"#/components/schemas/ProcessVariable"}},"processTemplateId":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int64"},"processTemplateDeviated":{"type":["null","string"],"format":"date-time"},"nextProcessTemplate":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/ProcessTemplate"}]},"performAdditionalSyntaxValidation":{"type":"boolean"},"isDeleted":{"type":"boolean"},"version":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"uniqueIdentifier":{"type":"string","format":"uuid"},"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"name":{"type":"string"},"modified":{"type":"string","format":"date-time"},"modifier":{"type":["null","string"]},"description":{"type":["null","string"]},"isNotLatestVersion":{"type":"boolean"},"changeDescription":{"type":["null","string"]}}},"ElementParameters":{"type":"object","properties":{"id":{"type":["null","string"]},"type":{"$ref":"#/components/schemas/ElementType"},"parameters":{"type":["null","object"],"additionalProperties":{"type":"array","items":{"type":"array","items":{}}}},"selectedTypeId":{"type":["null","string"]},"promoteResultAs":{"type":["null","string"]},"name":{"type":["null","string"]},"description":{"type":["null","string"]},"isDefault":{"type":["null","boolean"]},"shouldRetry":{"type":["null","boolean"]},"maxRetryCount":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int32"},"shouldNotLogResult":{"type":["null","boolean"]},"shouldDispose":{"type":["null","boolean"]}}},"ElementType":{"enum":["Start","Task","Decision","SequenceFlow","ConditionBranch","Return","Throw","CallActivity","SubProcess","ParallelForeach","SequentialForeach","While","Expression","SubProcessStartNode","Catch","InclusiveGateway","InclusiveDecisionBranch","IntermediateReturn","GlobalErrorHandler","TestTask","SharedState","Dmn","DataObjectReference","DataStoreReference","HydrationPoint","ScheduledRehydration","SignalRehydration","NativeAi","Vdm"]},"TaskSelectionData":{"type":"object","properties":{"uri":{"type":"string"},"argumentsJson":{"type":["null","string"]},"returnType":{"type":["null","string"]},"name":{"type":"string"},"displayName":{"type":["null","string"]},"packageName":{"type":"string"},"description":{"type":["null","string"]},"isNotLatestVersion":{"type":"boolean"},"isStandard":{"type":"boolean"},"isDotNet":{"type":"boolean"}}},"ProcessVariable":{"type":"object","properties":{"name":{"type":["null","string"]},"value":{"type":["null","string"]},"isSecret":{"type":"boolean"},"mode":{"type":["null","string"]},"description":{"type":["null","string"]}}},"ProcessTemplate":{"required":["uniqueIdentifier","isListed","version","isDeleted","majorVersion","minorVersion","name","modifier","modified","targetFramework","frendsVersion","isSubProcess","staticRequiredEnvironmentVariablesJson","staticRequiredCertificatesJson","allowedMcpToolsJson"],"type":"object","properties":{"uniqueIdentifier":{"type":"string","format":"uuid"},"isListed":{"type":"boolean"},"version":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"isDeleted":{"type":"boolean"},"processVariablesJson":{"maxLength":2147483647,"type":["null","string"]},"processTags":{"maxLength":2147483647,"type":["null","string"]},"documentation":{"oneOf":[{"type":"null"},{"$ref":"#/components/schemas/ProcessDocumentation"}]},"getVersion":{"pattern":"^\\d+(\\.\\d+){1,3}$","type":["null","string"]},"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"majorVersion":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"minorVersion":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"name":{"maxLength":512,"minLength":0,"type":"string"},"modifier":{"maxLength":256,"minLength":0,"type":"string"},"modified":{"type":"string","format":"date-time"},"targetFramework":{"maxLength":32,"minLength":0,"type":"string"},"frendsVersion":{"maxLength":64,"minLength":0,"type":"string"},"isSubProcess":{"type":"boolean"},"staticRequiredEnvironmentVariablesJson":{"maxLength":2147483647,"type":"string"},"staticRequiredCertificatesJson":{"maxLength":2147483647,"type":"string"},"description":{"maxLength":2147483647,"minLength":0,"type":["null","string"]},"changeDescription":{"maxLength":2147483647,"minLength":0,"type":["null","string"]},"bpmn":{"maxLength":2147483647,"minLength":0,"type":["null","string"]},"isForMonitoringRule":{"type":["null","boolean"]},"cancellationDisabled":{"type":["null","boolean"]},"elementParameters":{"maxLength":2147483647,"minLength":0,"type":["null","string"]},"promotedResultVariablesJson":{"maxLength":2147483647,"minLength":0,"type":["null","string"]},"usedSubprocessesJson":{"maxLength":2147483647,"minLength":0,"type":["null","string"]},"usedTasksJson":{"maxLength":2147483647,"minLength":0,"type":["null","string"]},"triggersJson":{"maxLength":2147483647,"minLength":0,"type":["null","string"]},"manualTriggerJson":{"maxLength":2147483647,"minLength":0,"type":["null","string"]},"allowedMcpToolsJson":{"maxLength":2147483647,"minLength":0,"type":"string"},"preserveReferencesAtCheckpoint":{"type":"boolean"}}},"ProcessDocumentation":{"required":["uniqueIdentifier","documentationMarkdown","modifier","majorVersion","minorVersion"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"uniqueIdentifier":{"type":"string","format":"uuid"},"documentationMarkdown":{"maxLength":2147483647,"type":"string"},"modifier":{"maxLength":256,"type":"string"},"majorVersion":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"minorVersion":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"modifiedUtc":{"type":"string","format":"date-time"}}}}}}
```

## The ResponseOfProcessInstanceExecutionDetailsViewModel object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ResponseOfProcessInstanceExecutionDetailsViewModel":{"required":["data"],"type":"object","properties":{"data":{"oneOf":[{"type":"null"},{"description":"Response data","$ref":"#/components/schemas/ProcessInstanceExecutionDetailsViewModel"}]}}},"ProcessInstanceExecutionDetailsViewModel":{"required":["parentName","processGuid","rootProcessGuid","environment","agentGroup","agent","userName","triggerName","processParameters","processReturnValues"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"parentId":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["null","integer","string"],"format":"int64"},"parentName":{"type":"string"},"executionId":{"type":"string","format":"uuid"},"processGuid":{"type":"string","format":"uuid"},"rootProcessGuid":{"type":["null","string"],"format":"uuid"},"processVersion":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"state":{"$ref":"#/components/schemas/ExecutionState"},"dehydrationState":{"$ref":"#/components/schemas/DehydrationState"},"stepDataUri":{"type":["null","string"]},"startTimeUtc":{"type":["null","string"],"format":"date-time"},"endTimeUtc":{"type":["null","string"],"format":"date-time"},"duration":{"pattern":"^-?(\\d+\\.)?\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,7})?$","type":["null","string"]},"environment":{"type":"string"},"agentGroup":{"type":"string"},"agent":{"type":"string"},"exception":{"type":["null","string"]},"userName":{"type":"string"},"triggerName":{"type":"string"},"processParameters":{"type":["null","array"],"items":{"type":"array","items":{"type":"array","items":{}}}},"processReturnValues":{"type":["null","array"],"items":{"type":"array","items":{}}},"hasLoggedSteps":{"type":["null","boolean"]},"correlationId":{"type":["null","string"]}}},"ExecutionState":{"enum":["Ok","Waiting","Launched","Starting","Started","Canceled","CanceledByTerminate","FinishedAsZombie","TerminatedByUser","ActionSkipped","Failed","Exception","Finished"]},"DehydrationState":{"enum":["Dehydrated","Hydrated","DehydrationProcessFailure",null]}}}}
```

## The ResponseOfProcessTemplateBase object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"ResponseOfProcessTemplateBase":{"required":["data"],"type":"object","properties":{"data":{"oneOf":[{"type":"null"},{"description":"Response data","$ref":"#/components/schemas/ProcessTemplateBase"}]}}},"ProcessTemplateBase":{"required":["name","bpmn"],"type":"object","properties":{"id":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"},"name":{"type":["null","string"]},"modifier":{"type":["null","string"]},"modified":{"type":"string","format":"date-time"},"majorVersion":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"minorVersion":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"targetFramework":{"type":"string"},"frendsVersion":{"type":"string"},"isSubprocess":{"type":"boolean"},"staticRequiredEnvironmentVariablesJson":{"type":"string"},"isForMonitoringRule":{"type":"boolean"},"cancellationDisabled":{"type":"boolean"},"preserveReferencesAtCheckpoint":{"type":"boolean"},"description":{"type":["null","string"]},"changeDescription":{"type":["null","string"]},"bpmn":{"type":["null","string"]},"elementParameters":{"type":["null","string"]},"promotedResultVariablesJson":{"type":["null","string"]},"usedSubprocessesJson":{"type":["null","string"]},"usedTasksJson":{"type":["null","string"]},"triggersJson":{"type":["null","string"]},"manualTriggerJson":{"type":["null","string"]},"allowedMcpToolsJson":{"type":"string"},"uniqueIdentifier":{"type":"string","format":"uuid"},"isListed":{"type":"boolean"},"version":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"isDeleted":{"type":"boolean"},"processVariablesJson":{"type":["null","string"]},"processTags":{"type":["null","string"]},"templateTags":{"type":"array","items":{"type":"string"}},"getVersion":{"pattern":"^\\d+(\\.\\d+){1,3}$","type":["null","string"]}}}}}}
```

## The RevokeCertificateRequest object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"RevokeCertificateRequest":{"type":"object","properties":{"reason":{"description":"Why the certificate is revoked (Unspecified, KeyCompromise, Superseded or CessationOfOperation); KeyCompromise when the private key may have leaked","$ref":"#/components/schemas/AcmeRevocationReason"}}},"AcmeRevocationReason":{"enum":["Unspecified","KeyCompromise","Superseded","CessationOfOperation"],"default":"Unspecified"}}}}
```

## The StringSegment object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"StringSegment":{"type":"object","properties":{"buffer":{"type":["null","string"]},"offset":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"length":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int32"},"value":{"type":["null","string"]},"hasValue":{"type":"boolean"}}}}}}
```

## The TagElementType object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"TagElementType":{"enum":["Process","ProcessTemplate","PrivateApplication","ApiPolicy"]}}}}
```

## The TagRequestModel object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"TagRequestModel":{"type":"object","properties":{"elementType":{"description":"Element type i.e. Process, ProcessTemplate, PrivateApplication, ApiPolicy","$ref":"#/components/schemas/TagElementType"},"tags":{"type":"array","items":{"type":"string"},"description":"List of tags"},"elementGuids":{"type":"array","items":{"type":"string","format":"uuid"},"description":"List of element unique identifiers"}}},"TagElementType":{"enum":["Process","ProcessTemplate","PrivateApplication","ApiPolicy"]}}}}
```

## The TaskSelectionData object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"TaskSelectionData":{"type":"object","properties":{"uri":{"type":"string"},"argumentsJson":{"type":["null","string"]},"returnType":{"type":["null","string"]},"name":{"type":"string"},"displayName":{"type":["null","string"]},"packageName":{"type":"string"},"description":{"type":["null","string"]},"isNotLatestVersion":{"type":"boolean"},"isStandard":{"type":"boolean"},"isDotNet":{"type":"boolean"}}}}}}
```

## The TemplateType object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"TemplateType":{"enum":["All","ProcessTemplatesOnly","SubprocessTemplatesOnly",null]}}}}
```

## The UpdateProcessesBasedOnTemplateRequestBody object

```json
{"openapi":"3.1.1","info":{"title":"Frends API","version":"1.0.0"},"components":{"schemas":{"UpdateProcessesBasedOnTemplateRequestBody":{"required":["processIds"],"type":"object","properties":{"processIds":{"type":"array","items":{"pattern":"^-?(?:0|[1-9]\\d*)$","type":["integer","string"],"format":"int64"}}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.frends.com/reference/frends-platform-api/platform-api-reference/models.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
