Heretto Deploy API

https://help.heretto.com/en/heretto-deploy-api/
Admin
Heretto Deploy API is a content delivery service that processes content from Heretto CCMS and...
Tokens:13,224
Snippets:98
Trust Score:9.3
Update:6 months ago
Show doc for...
Tokens:
Raw
### Unfiltered Content Link Example

Source: https://help.heretto.com/en/heretto-deploy-api/deploy-api-filtering-and-personalization

This example shows a link to content without any audience filtering. It includes the JWT but not the 'audience' parameter.

```url
web_asset_address/sitemap_path/endpoint?token=JWT
```

--------------------------------

### Filtered Content Link Example with Audience

Source: https://help.heretto.com/en/heretto-deploy-api/deploy-api-filtering-and-personalization

This example demonstrates a link to filtered content. It includes the JWT and the 'audience' parameter, which specifies the desired audience.

```url
web_asset_address/sitemap_path/endpoint?token=JWT&audience=audience_name
```

--------------------------------

### GET /deployments/{deploymentIdentifier}

Source: https://help.heretto.com/en/heretto-deploy-api/deploy-api-endpoint-specification/get-deployment

Returns deployment details, including the list of available locales and information contained in the sitemeta.

```APIDOC
## GET /deployments/{deploymentIdentifier}

### Description
Returns deployment details, including the list of available locales and information contained in the sitemeta.

### Method
GET

### Endpoint
https://{organizationId}.deploy.heretto.com/v4/deployments/{deploymentIdentifier}

### Parameters
#### Path Parameters
- **deploymentIdentifier** (string) - Required - Deployment identifier

#### Query Parameters
- **audience** (string) - Optional - Name of an audience defined for this deployment. Filters the response for this audience.
- **token** (string) - Optional - Deploy API token

#### Headers
- **X-Deploy-API-Auth** (string) - Optional - Deploy API token (preferred)

### Response
#### Success Response (200)
- **title** (string) - Title of the deployment
- **sitemeta** (dictionary[string, object]) - Metadata for the site
- **availableLocales** (array[string]) - List of available locales
- **bucketName** (string) - Bucket name
- **deploymentIdentifier** (string) - Deployment identifier
- **snapshotId** (string) - Snapshot ID
- **mapId** (string) - Map ID
- **publishingDate** (string) - Publishing date
- **schemaVersion** (string) - Schema version
- **version** (string) - Version
- **gitCommit** (string) - Git commit hash
- **deploymentType** (string) - Type of deployment

#### Response Example
{
  "title": "string",
  "sitemeta": {
    "property1": {},
    "property2": {}
  },
  "availableLocales": [
    "string"
  ],
  "bucketName": "string",
  "deploymentIdentifier": "string",
  "snapshotId": "string",
  "mapId": "string",
  "publishingDate": "string",
  "schemaVersion": "string",
  "version": "string",
  "gitCommit": "string",
  "deploymentType": "string"
}
```

--------------------------------

### Get Deployment Details using cURL

Source: https://help.heretto.com/en/heretto-deploy-api/deploy-api-endpoint-specification/get-deployment

Use this cURL command to make a GET request to the Heretto Deploy API to retrieve details for a specific deployment. Ensure you replace placeholders with your organization ID, deployment identifier, and API token.

```curl
curl --request GET \
  --url https://organizationid.deploy.heretto.com/v4/deployments/deploymentIdentifier \
  --header 'Accept: application/json' \
  --header 'X-Deploy-API-Auth: '
```

--------------------------------

### Example JWT Token

Source: https://help.heretto.com/en/heretto-deploy-api/deploy-api-authentication

A sample base64-encoded JWT string consisting of header, payload, and signature.

```text
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWRpZW5jZSI6InlvdXJfYXVkaWVuY2VfbmFtZSJ9.b3DJPBQNkD-qY_0tbPIrqI-Dz6nbFVIBnIzWto_Nal4
```

--------------------------------

### Heretto Deploy API Search Endpoint URL with Values

Source: https://help.heretto.com/en/heretto-deploy-api/deploy-api-authentication

An example of the search endpoint URL after replacing the organization ID and deployment identifier with actual values.

```text
https://thunderbird.deploy.heretto.com/v4/deployments/I9vA3KlK1331IYmEHhU/search
```

--------------------------------

### Heretto Deploy API Search Response Example

Source: https://help.heretto.com/en/heretto-deploy-api/deploy-api-endpoint-specification/search-pages

Illustrates the structure of a successful response from the Heretto Deploy API's search endpoint. It includes total results, search hits, and detailed metadata for each hit.

```json
{
  "totalResults": -2147483648,
  "hits": [
    {
      "breadcrumbs": [
        {
          "title": "string",
          "href": "string",
          "shortDescription": "string",
          "binaryHref": "string",
          "id": "string",
          "type": "string",
          "outputclasses": [
            "string"
          ],
          "contentHref": "string"
        }
      ],
      "highlights": [
        "string"
      ],
      "standardMetadata": {
        "taxonomy": {
          "property1": {
            "humanReadable": "string",
            "value": "string",
            "values": [
              {
                "value": "string",
                "humanReadable": "string"
              }
            ]
          },
          "property2": {
            "humanReadable": "string",
            "value": "string",
            "values": [
              {
                "value": "string",
                "humanReadable": "string"
              }
            ]
          }
        },
        "date": {
          "property1": {
            "humanReadable": "string",
            "value": "string",
            "values": [
              {
                "value": "string",
                "humanReadable": "string"
              }
            ]
          },
          "property2": {
            "humanReadable": "string",
            "value": "string",
            "values": [
              {
                "value": "string",
                "humanReadable": "string"
              }
            ]
          }
        },
        "label": {
          "property1": {
            "humanReadable": "string",
            "value": "string",
            "values": [
              {
                "value": "string",
                "humanReadable": "string"
              }
            ]
          },
          "property2": {
            "humanReadable": "string",
            "value": "string",
            "values": [
              {
                "value": "string",
                "humanReadable": "string"
              }
            ]
          }
        },
        "text_single_Line": {
          "property1": {
            "humanReadable": "string",
            "value": "string",
            "values": [
              {
                "value": "string",
                "humanReadable": "string"
              }
            ]
          },
          "property2": {
            "humanReadable": "string",
            "value": "string",
            "values": [
              {
                "value": "string",
                "humanReadable": "string"
              }
            ]
          }
        }
      },
      "customMetadata": {},
      "explanation": "string",
      "title": "string",
      "href": "string",
      "shortDescription": "string",
      "openApiPageInfo": {},
      "facets": [
        {
          "path": [
            {
              "title": "string",
              "count": -2147483648
            }
          ],
          "hierarchicalFacets": [
            {
              "id": "string",
              "title": "string",
              "count": -2147483648
            }
          ]
        }
      ]
    }
  ]
}
```

--------------------------------

### Get OpenAPI Specification using cURL

Source: https://help.heretto.com/en/heretto-deploy-api/deploy-api-endpoint-specification/get-open-api-specification

Use this cURL command to make a GET request to retrieve the OpenAPI specification for a deployment. Ensure you replace placeholders like organizationid, deploymentIdentifier, and specificationId with your actual values. The X-Deploy-API-Auth header is preferred for authentication.

```curl
curl --request GET \
  --url https://organizationid.deploy.heretto.com/v4/deployments/deploymentIdentifier/api-specification/specificationId \
  --header 'Accept: application/json' \
  --header 'Accept-Language: ' \
  --header 'X-Deploy-API-Auth: '
```

--------------------------------

### Get Changed Content - cURL Request

Source: https://help.heretto.com/en/heretto-deploy-api/deploy-api-endpoint-specification/get-files-changed-since

Use this cURL command to make a GET request to the 'changed_content' endpoint. Ensure you replace placeholders like 'organizationid' and 'deploymentIdentifier' with your specific values. The 'X-Deploy-API-Auth' header is used for authentication.

```curl
curl --request GET \
  --url https://organizationid.deploy.heretto.com/v4/deployments/deploymentIdentifier/changed_content \
  --header 'Accept: */*' \
  --header 'X-Deploy-API-Auth: '
```

--------------------------------

### Heretto Deploy API Search Request (cURL)

Source: https://help.heretto.com/en/heretto-deploy-api/deploy-api-endpoint-specification/search-pages

Example of how to send a search request to the Heretto Deploy API using cURL. Ensure you replace placeholders like 'organizationid' and 'deploymentIdentifier' with your specific values.

```shell
curl --request POST \
  --url https://organizationid.deploy.heretto.com/v4/deployments/deploymentIdentifier/search \
  --header 'Accept: application/json' \
  --header 'Accept-Language: ' \
  --header 'Content-Type: text/plain' \
  --header 'X-Deploy-API-Auth: ' \
  --data '{ \
  "queryString": "string", \
  "drilldowns": [ \
    [ \
      [ \
        "string" \
      ] \
    ] \
  ], \
  "refineToPaths": [ \
    "string" \
  ], \
  "addPrefix": true, \
  "includeExplanation": true, \
  "facetRequests": [ \
    [ \
      "string" \
    ] \
  ], \
  "startOffset": -2147483648, \
  "endOffset": -2147483648, \
  "hierarchical_facets": true, \
  "show_facets_missing_from_taxonomy": true, \
  "convertDoubleQuotesToStraight": true, \
  "autoGeneratePhraseQueries": true \
}'
```

--------------------------------

### GET /v4/deployments/{deploymentIdentifier}/content

Source: https://help.heretto.com/en/heretto-deploy-api/deploy-api-endpoint-specification/get-content

Retrieves the content for a specific deployment identifier.

```APIDOC
## GET /v4/deployments/{deploymentIdentifier}/content

### Description
Retrieves the content associated with a specific deployment identifier.

### Method
GET

### Endpoint
https://{organizationId}.deploy.heretto.com/v4/deployments/{deploymentIdentifier}/content

### Parameters
#### Path Parameters
- **deploymentIdentifier** (string) - Required - The unique identifier for the deployment.

#### Query Parameters
- **audience** (string) - Optional - Filter by audience.
- **for-id** (string) - Optional - Filter by ID.
- **for-path** (string) - Optional - Filter by path.
- **for-resourceid** (string) - Optional - Filter by resource ID.
- **include-metadata** (string) - Optional - Include metadata in the response.
- **resourceid-versionId** (string) - Optional - Filter by resource ID and version ID.
- **token** (string) - Optional - Authentication token.
- **view** (string) - Optional - Specify the view.

### Request Example
curl --request GET \
  --url https://organizationid.deploy.heretto.com/v4/deployments/deploymentIdentifier/content \
  --header 'Accept: application/json' \
  --header 'Accept-Language: ' \
  --header 'X-Deploy-API-Auth: '

### Response
#### Success Response (200)
- **content** (string) - The content body.
- **title** (string) - The title of the content.
- **href** (string) - The reference link.

#### Response Example
{
  "content": "string",
  "title": "string",
  "href": "string"
}
```

--------------------------------

### GET /deployments/{deploymentIdentifier}/structure

Source: https://help.heretto.com/en/heretto-deploy-api/deploy-api-endpoint-specification/get-structure

Retrieves the hierarchy of pages in a specified deployment, with options for filtering by audience, depth, and path.

```APIDOC
## GET /deployments/{deploymentIdentifier}/structure

### Description
Returns the hierarchy of the pages in the deployment.

### Method
GET

### Endpoint
https://{organizationId}.deploy.heretto.com/v4/deployments/{deploymentIdentifier}/structure

### Parameters
#### Path Parameters
- **deploymentIdentifier** (string) - Required - Deployment identifier

#### Query Parameters
- **audience** (string) - Optional - Name of an audience defined for this deployment. Filters the response for this audience.
- **depth** (string) - Optional - Depth of children in the returned structure. Depth of -1 indicates full depth. Depth of zero returns the item without children. Depths between 1 and 25 return the specified depth of children.
- **for-path** (string) - Optional - The path (href) to a page. The response starts at the matching page.
- **full** (string) - Optional - Deprecated. If 'true', returns full structure depth. Replacing this behavior is `depth=-1`
- **include-metadata-v2** (boolean) - Optional - Include metadata in the response.
- **token** (string) - Optional - Deploy API token

### Headers
- **X-Deploy-API-Auth** (string) - Deploy API token (preferred)

### Response
#### Success Response (200)
- Returns deployment structure
```

--------------------------------

### GET Deployment Content

Source: https://help.heretto.com/en/heretto-deploy-api/deploy-api-endpoint-specification/get-content

Use this cURL command to retrieve deployment content. Ensure you replace placeholders like 'organizationid' and 'deploymentIdentifier' with your specific values. Authentication headers are required.

```shell
curl --request GET \
  --url https://organizationid.deploy.heretto.com/v4/deployments/deploymentIdentifier/content \
  --header 'Accept: application/json' \
  --header 'Accept-Language: ' \
  --header 'X-Deploy-API-Auth: '
```

--------------------------------

### GET /v4/deployments/{deploymentIdentifier}/structure

Source: https://help.heretto.com/en/heretto-deploy-api/deploy-api-endpoint-specification/get-structure

Retrieves the structure of a specific deployment identified by the deploymentIdentifier.

```APIDOC
## GET /v4/deployments/{deploymentIdentifier}/structure

### Description
Retrieves the structure of a specific deployment identified by the deploymentIdentifier.

### Method
GET

### Endpoint
https://{organizationId}.deploy.heretto.com/v4/deployments/{deploymentIdentifier}/structure

### Parameters
#### Path Parameters
- **deploymentIdentifier** (string) - Required - The unique identifier for the deployment.

#### Query Parameters
- **audience** (string) - Optional - Filter by audience.
- **depth** (integer) - Optional - The depth of the structure to retrieve.
- **for-path** (string) - Optional - Filter by path.
- **full** (boolean) - Optional - Whether to retrieve the full structure.
- **include-metadata-v2** (boolean) - Optional - Whether to include v2 metadata.
- **token** (string) - Optional - Authentication token.

### Request Example
```bash
curl --request GET \
  --url https://organizationid.deploy.heretto.com/v4/deployments/deploymentIdentifier/structure \
  --header 'Accept: application/json' \
  --header 'X-Deploy-API-Auth: '
```

### Response
#### Success Response (200)
- **type** (string) - The type of the object.
- **title** (string) - The title of the object.
- **href** (string) - The reference link.
- **id** (string) - The unique identifier.

#### Response Example
{
  "type": "string",
  "title": "string",
  "href": "string",
  "shortdesc": "string",
  "id": "string"
}
```

--------------------------------

### GET /deployments/{deploymentIdentifier}/content

Source: https://help.heretto.com/en/heretto-deploy-api/deploy-api-endpoint-specification/get-content

Retrieves the HTML content and metadata of a page. Optionally supports returning normalized DITA for active sync deployments.

```APIDOC
## GET /deployments/{deploymentIdentifier}/content

### Description
Returns the HTML content and the metadata of a page. If the view parameter is set to `dita`, returns normalized DITA (active sync deployments only).

### Method
GET

### Endpoint
https://{organizationId}.deploy.heretto.com/v4/deployments/{deploymentIdentifier}/content

### Parameters
#### Path Parameters
- **deploymentIdentifier** (string) - Required - Deployment identifier

#### Query Parameters
- **audience** (string) - Optional - Name of an audience defined for this deployment. Filters the response for this audience.
- **for-id** (string) - Optional - The ID attribute of a topic or topicref. Only one of the parameters is allowed: 'for-path' or 'for-id' or 'for-resourceid'.
- **for-path** (string) - Optional - The path (href) for a page. Only one of the parameters is allowed: 'for-path' or 'for-id' or 'for-resourceid'.
- **for-resourceid** (string) - Optional - A DITA resource ID to find a matching page. Only one of the parameters is allowed: 'for-path' or 'for-id' or 'for-resourceid'.
- **include-metadata** (string) - Optional - Include metadata in the response. Not required, true by default.
- **resourceid-versionId** (string) - Optional - Specifies a version ID from the sitemap to prioritize when searching for the 'resourceid'.
- **token** (string) - Optional - Deploy API token
- **view** (string) - Optional - Defines the format for the content field. Defaults to HTML. If the value is `dita`, the content field is normalized DITA.

### Headers
- **Accept-Language** (string) - Optional - Specifies the preferred locales for the response.
- **X-Deploy-API-Auth** (string) - Optional - Deploy API token (preferred).

### Response
#### Success Response (200)
- Returns page content and metadata
```

--------------------------------

### Heretto Deploy API Successful Response Example

Source: https://help.heretto.com/en/heretto-deploy-api/deploy-api-authentication

A successful API call to the Heretto Deploy API returns a 200 status code and the requested content in a JSON object. The 'data' field contains the actual response payload.

```json
{
    "status": "success",
    "data": {...}
  }
```

--------------------------------

### Get OpenAPI specification

Source: https://help.heretto.com/en/heretto-deploy-api/deploy-api-endpoint-specification/get-open-api-specification

Retrieves the OpenAPI specification for a given deployment and specification ID. The returned specification will be in OpenAPI version 3.0.1 format.

```APIDOC
## GET /deployments/{deploymentIdentifier}/api-specification/{specificationId}

### Description
Returns the OpenAPI specification based on the specification ID in the deployment. The specification returned will be OpenAPI version 3.0.1. If you add a file to the deployment with a lower version, or a Swagger file, it will be upgraded to OpenAPI version 3.0.1.

### Method
GET

### Endpoint
https://{organizationId}.deploy.heretto.com/v4/deployments/{deploymentIdentifier}/api-specification/{specificationId}

### Parameters
#### Path Parameters
- **deploymentIdentifier** (string) - Required - Deployment identifier
- **specificationId** (string) - Required - The ID of the open API spec document, returned by the content response

#### Query Parameters
- **audience** (string) - Optional - Name of an audience defined for this deployment. Filters the response for this audience.
- **token** (string) - Optional - Deploy API token

#### Headers
- **Accept-Language** (string) - Optional - Specifies the preferred locales for the response, following HTTP 'Accept-Language' header specifications. If not present, uses the default locale. The selected locale will be in the response, in the Content-Language header. If no locale can be selected, the response is 406.
- **X-Deploy-API-Auth** (string) - Optional - Deploy API token (preferred)

### Responses
#### Success Response (200)
- **string** (string) - Returns OpenAPI specification

#### Response Example
```
1
```

### Request Example
```json
{
  "example": "curl --request GET \n  --url https://organizationid.deploy.heretto.com/v4/deployments/deploymentIdentifier/api-specification/specificationId \n  --header 'Accept: application/json' \n  --header 'Accept-Language: ' \n  --header 'X-Deploy-API-Auth: '"
}
```
```

--------------------------------

### Define Sitemap Data Element

Source: https://help.heretto.com/en/heretto-deploy-api/deploy-api-authentication

Example of a data element in a sitemap referencing a DITAVAL file.

```xml
<data href="../filters/private.ditaval" name="content-api-audience" value="private"/>
```

--------------------------------

### GET /deployments/{deploymentIdentifier}/audiences

Source: https://help.heretto.com/en/heretto-deploy-api/deploy-api-endpoint-specification/get-audiences

Returns an unsorted array of audiences included in the specified deployment.

```APIDOC
## GET /deployments/{deploymentIdentifier}/audiences

### Description
Returns an unsorted array of audiences included in the deployment. The returned audiences correspond to those configured in the sitemap or the CCMS deployment configuration interface.

### Method
GET

### Endpoint
https://{organizationId}.deploy.heretto.com/v4/deployments/{deploymentIdentifier}/audiences

### Parameters
#### Path Parameters
- **deploymentIdentifier** (string) - Required - Deployment identifier

#### Query Parameters
- **token** (string) - Optional - Deploy API token

### Request Example
```
curl --request GET \
  --url https://organizationid.deploy.heretto.com/v4/deployments/deploymentIdentifier/audiences \
  --header 'Accept: */*' \
  --header 'X-Deploy-API-Auth: '
```

### Response
#### Success Response (200)
- **audiences** (array[string]) - Returns an array of strings representing the audiences included in the deployment.
```

--------------------------------

### GET /deployments/{deploymentIdentifier}/changed_content

Source: https://help.heretto.com/en/heretto-deploy-api/deploy-api-endpoint-specification/get-files-changed-since

Retrieves the deployment path, file UUID, audiences, locales, and modification date of content that has changed since the previous manual deployment.

```APIDOC
## GET /deployments/{deploymentIdentifier}/changed_content

### Description
Returns deployment path, file UUID, audiences, locales, and modification date of content that changed since the previous manual deployment. Not available in active sync deployments.

### Method
GET

### Endpoint
https://{organizationId}.deploy.heretto.com/v4/deployments/{deploymentIdentifier}/changed_content

### Parameters
#### Path Parameters
- **deploymentIdentifier** (string) - Required - Deployment identifier

#### Query Parameters
- **audience** (string) - Optional - Name of an audience defined for this deployment. Filters the response for this audience.
- **changed_since** (string) - Optional - Return content changed since date time specified. Date time should be in ISO 8601 format
- **locale** (string) - Optional - Locale
- **path_contains** (string) - Optional - Path filter - filters paths which contains given text
- **token** (string) - Optional - Deploy API token

#### Headers
- **X-Deploy-API-Auth** (string) - Optional - Deploy API token (preferred)

### Response
#### Success Response (200)
- **path** (string) - Deployment path
- **fileUuid** (string) - File UUID
- **audience** (string) - Audience
- **locale** (string) - Locale
- **contentModificationDate** (string) - Modification date in ISO8601 format

### Request Example
curl --request GET \
  --url https://organizationid.deploy.heretto.com/v4/deployments/deploymentIdentifier/changed_content \
  --header 'Accept: */*' \
  --header 'X-Deploy-API-Auth: '
```

--------------------------------

### Get source file details for a path

Source: https://help.heretto.com/en/heretto-deploy-api/deploy-api-endpoint-specification/get-source-files

Retrieves a list of CCMS DITA topics used to render a specified page, including topic title, UUID, and topicId. Handles chunked content and filters by audience or path.

```APIDOC
## GET /deployments/{deploymentIdentifier}/source_files

### Description
Returns a list of CCMS DITA topics used to render a specified page. Each result includes the topic title, UUID (for building a button that opens contributing topics in the CCMS directly from the portal) and topicId (for contextual information and locating elements within the rendered HTML output). For chunked content where multiple topics contribute to a single page, returns multiple topic entries corresponding to each contributing topic. Does not return DITA maps.

### Method
GET

### Endpoint
https://{organizationId}.deploy.heretto.com/v4/deployments/{deploymentIdentifier}/source_files

### Parameters
#### Path Parameters
- **deploymentIdentifier** (string) - Required - Deployment identifier

#### Query Parameters
- **audience** (string) - Optional - Name of an audience defined for this deployment. Filters the response for this audience.
- **for-path** (string) - Optional - The path (href) to a page. The response starts at the matching page.
- **token** (string) - Optional - Deploy API token

#### Headers
- **Accept-Language** (string) - Optional - Specifies the preferred locales for the response, following HTTP 'Accept-Language' header specifications. If not present, uses the default locale. The selected locale will be in the response, in the Content-Language header. If no locale can be selected, the response is 406.
- **X-Deploy-API-Auth** (string) - Optional - Deploy API token (preferred)

### Request Example
```curl
curl --request GET \
  --url https://organizationid.deploy.heretto.com/v4/deployments/deploymentIdentifier/source_files \
  --header 'Accept: */*' \
  --header 'Accept-Language: ' \
  --header 'X-Deploy-API-Auth: '
```

### Response
#### Success Response (200)
- **uuid** (string) - Unique identifier for the topic.
- **title** (string) - The title of the topic.
- **topicId** (string) - The identifier for the topic.

#### Response Example
```json
[
  {
    "uuid": "string",
    "title": "string",
    "topicId": "string"
  }
]
```
```

--------------------------------

### GET /deployments/{deploymentIdentifier}/locales

Source: https://help.heretto.com/en/heretto-deploy-api/deploy-api-endpoint-specification/get-locales

Retrieves an unsorted array of locale codes included in a specific deployment. These locales correspond to those configured in the Heretto CCMS deployment configuration. If no locales are configured, it defaults to 'en'.

```APIDOC
## GET /deployments/{deploymentIdentifier}/locales

### Description
Returns an unsorted array of locale codes, like `en`, `es-es`, included in the deployment. The returned locales correspond to those configured in the CCMS deployment configuration interface. If no locales are configured, it defaults to `en`.

### Method
GET

### Endpoint
`https://{organizationId}.deploy.heretto.com/v4/deployments/{deploymentIdentifier}/locales`

### Parameters
#### Path Parameters
- **deploymentIdentifier** (string) - required - Deployment identifier

#### Query Parameters
- **token** (string) - optional - Deploy API token

#### Headers
- **X-Deploy-API-Auth** (string) - required - Deploy API token (preferred)

### Responses
#### Success Response (200)
- **locales** (array[string]) - An array of locale codes.

#### Response Example
```json
["en", "es-es"]
```

### Request Example
```
curl --request GET \
  --url https://organizationid.deploy.heretto.com/v4/deployments/deploymentIdentifier/locales \
  --header 'Accept: */*' \
  --header 'X-Deploy-API-Auth: YOUR_DEPLOY_API_TOKEN'
```
```

--------------------------------

### Get Included Locales API Request

Source: https://help.heretto.com/en/heretto-deploy-api/deploy-api-endpoint-specification/get-locales

Use this cURL command to retrieve a list of locale codes included in a specific deployment. Ensure you replace placeholder values with your actual organization ID, deployment identifier, and API token.

```shell
curl --request GET \
  --url https://organizationid.deploy.heretto.com/v4/deployments/deploymentIdentifier/locales \
  --header 'Accept: */*' \
  --header 'X-Deploy-API-Auth: '
```

--------------------------------

### Heretto Deploy API Simple API Key URL Parameter Authentication

Source: https://help.heretto.com/en/heretto-deploy-api/deploy-api-authentication

Authenticate API requests by appending a Simple API Key as a URL parameter. The key should be added to the 'token' query parameter.

```text
https://thunderbird.deploy.heretto.com/v4/deployments/I9vA3KlK1331IYmEHhU/structure?token=a59ac183a8bc4a848c92082f91b863dc
```

--------------------------------

### Retrieve source file details via cURL

Source: https://help.heretto.com/en/heretto-deploy-api/deploy-api-endpoint-specification/get-source-files

Use this cURL command to request source file details for a specific deployment path. Ensure the organizationId, deploymentIdentifier, and authentication headers are correctly populated.

```shell
curl --request GET \
  --url https://organizationid.deploy.heretto.com/v4/deployments/deploymentIdentifier/source_files \
  --header 'Accept: */*' \
  --header 'Accept-Language: ' \
  --header 'X-Deploy-API-Auth: '
```

--------------------------------

### Heretto Deploy API Simple API Key Header Authentication

Source: https://help.heretto.com/en/heretto-deploy-api/deploy-api-authentication

Authenticate API requests using a Simple API Key provided in the request header. Ensure the key is correctly formatted and included in the 'X-Deploy-API-Auth' header.

```curl
curl --location 'https://thunderbird.deploy.heretto.com/v4/deployments/I9vA3KlK1331IYmEHhU/structure' \
--header 'X-Deploy-API-Auth: a59ac183a8bc4a848c92082f91b863dc'
```

--------------------------------

### Heretto Deploy API - Deployment Details Response

Source: https://help.heretto.com/en/heretto-deploy-api/deploy-api-endpoint-specification/get-deployment

This is a sample JSON response from the Heretto Deploy API when requesting deployment details. It includes information such as the deployment title, available locales, bucket name, and identifiers.

```json
{
  "title": "string",
  "sitemeta": {
    "property1": {},
    "property2": {}
  },
  "availableLocales": [
    "string"
  ],
  "bucketName": "string",
  "deploymentIdentifier": "string",
  "snapshotId": "string",
  "mapId": "string",
  "publishingDate": "string",
  "schemaVersion": "string",
  "version": "string",
  "gitCommit": "string",
  "deploymentType": "string"
}
```

--------------------------------

### Retrieve Deployment Structure via cURL

Source: https://help.heretto.com/en/heretto-deploy-api/deploy-api-endpoint-specification/get-structure

Use this cURL command to fetch the structure of a specific deployment. Ensure the organizationId and deploymentIdentifier are correctly specified in the URL.

```shell
curl --request GET \
  --url https://organizationid.deploy.heretto.com/v4/deployments/deploymentIdentifier/structure \
  --header 'Accept: application/json' \
  --header 'X-Deploy-API-Auth: '
```

--------------------------------

### Retrieve deployment audiences via cURL

Source: https://help.heretto.com/en/heretto-deploy-api/deploy-api-endpoint-specification/get-audiences

Use this cURL command to fetch the list of audiences for a specific deployment. Ensure the X-Deploy-API-Auth header is populated with your valid API token.

```shell
curl --request GET \
  --url https://organizationid.deploy.heretto.com/v4/deployments/deploymentIdentifier/audiences \
  --header 'Accept: */*' \
  --header 'X-Deploy-API-Auth: '
```

--------------------------------

### Deployment Structure Response Schema

Source: https://help.heretto.com/en/heretto-deploy-api/deploy-api-endpoint-specification/get-structure

The expected JSON response structure for the deployment structure endpoint, containing metadata, taxonomy, and content details.

```json
1
{
2
  "type": "string",
3
  "title": "string",
4
  "href": "string",
5
  "shortdesc": "string",
6
  "shortDescription": "string",
7
  "id": "string",
8
  "topicId": "string",
9
  "meta": [
10
    {
11
      "property1": "string",
12
      "property2": "string"
13
    }
14
  ],
15
  "externalLink": true,
16
  "standardMetadata": {
17
    "taxonomy": {
18
      "property1": {
19
        "humanReadable": "string",
20
        "value": "string",
21
        "values": [
22
          {
23
            "value": "string",
24
            "humanReadable": "string"
25
          }
26
        ]
27
      },
28
      "property2": {
29
        "humanReadable": "string",
30
        "value": "string",
31
        "values": [
32
          {
33
            "value": "string",
34
            "humanReadable": "string"
35
          }
36
        ]
37
      }
38
    },
39
    "date": {
40
      "property1": {
41
        "humanReadable": "string",
42
        "value": "string",
43
        "values": [
44
          {
45
            "value": "string",
46
            "humanReadable": "string"
47
          }
48
        ]
49
      },
50
      "property2": {
51
        "humanReadable": "string",
52
        "value": "string",
53
        "values": [
54
          {
55
            "value": "string",
56
            "humanReadable": "string"
57
          }
58
        ]
59
      }
60
    },
61
    "label": {
62
      "property1": {
63
        "humanReadable": "string",
64
        "value": "string",
65
        "values": [
66
          {
67
            "value": "string",
68
            "humanReadable": "string"
69
          }
70
        ]
71
      },
72
      "property2": {
73
        "humanReadable": "string",
74
        "value": "string",
75
        "values": [
76
          {
77
            "value": "string",
78
            "humanReadable": "string"
79
          }
80
        ]
81
      }
82
    },
83
    "text_single_Line": {
84
      "property1": {
85
        "humanReadable": "string",
86
        "value": "string",
87
        "values": [
88
          {
89
            "value": "string",
90
            "humanReadable": "string"
91
          }
92
        ]
93
      },
94
      "property2": {
95
        "humanReadable": "string",
96
        "value": "string",
97
        "values": [
98
          {
99
            "value": "string",
100
            "humanReadable": "string"
101
          }
102
        ]
103
      }
104
    }
105
  },
106
  "customMetadata": {
107
    "taxonomy": {
108
      "property1": {
109
        "humanReadable": "string",
110
        "value": "string",
111
        "values": [
112
          {
113
            "value": "string",
114
            "humanReadable": "string"
115
          }
116
        ]
117
      },
118
      "property2": {
119
        "humanReadable": "string",
120
        "value": "string",
121
        "values": [
122
          {
123
            "value": "string",
124
            "humanReadable": "string"
125
          }
126
        ]
127
      }
128
    },
129
    "date": {
130
      "property1": {
131
        "humanReadable": "string",
132
        "value": "string",
133
        "values": [
134
          {
135
            "value": "string",
136
            "humanReadable": "string"
137
          }
138
        ]
139
      },
140
      "property2": {
141
        "humanReadable": "string",
142
        "value": "string",
143
        "values": [
144
          {
145
            "value": "string",
146
            "humanReadable": "string"
147
          }
148
        ]
149
      }
150
    },
151
```

--------------------------------

### POST /v4/deployments/{deploymentIdentifier}/search

Source: https://help.heretto.com/en/heretto-deploy-api/deploy-api-endpoint-specification/search-pages

Performs a search query against a specific deployment using the provided search parameters.

```APIDOC
## POST /v4/deployments/{deploymentIdentifier}/search

### Description
Performs a search query against a specific deployment.

### Method
POST

### Endpoint
/v4/deployments/{deploymentIdentifier}/search

### Parameters
#### Path Parameters
- **deploymentIdentifier** (string) - Required - The unique identifier for the deployment.

#### Request Body
- **queryString** (string) - Optional - The search query string.
- **drilldowns** (array) - Optional - Drilldown filters for the search.
- **refineToPaths** (array) - Optional - Paths to refine the search results.
- **addPrefix** (boolean) - Optional - Whether to add a prefix.
- **includeExplanation** (boolean) - Optional - Whether to include an explanation in the response.
- **facetRequests** (array) - Optional - Facet requests for the search.
- **startOffset** (integer) - Optional - The starting offset for pagination.
- **endOffset** (integer) - Optional - The ending offset for pagination.
- **hierarchical_facets** (boolean) - Optional - Whether to use hierarchical facets.
- **show_facets_missing_from_taxonomy** (boolean) - Optional - Whether to show facets missing from the taxonomy.
- **convertDoubleQuotesToStraight** (boolean) - Optional - Whether to convert double quotes to straight quotes.
- **autoGeneratePhraseQueries** (boolean) - Optional - Whether to automatically generate phrase queries.

### Request Example
{
  "queryString": "string",
  "drilldowns": [[["string"]]],
  "refineToPaths": ["string"],
  "addPrefix": true,
  "includeExplanation": true,
  "facetRequests": [["string"]],
  "startOffset": -2147483648,
  "endOffset": -2147483648,
  "hierarchical_facets": true,
  "show_facets_missing_from_taxonomy": true,
  "convertDoubleQuotesToStraight": true,
  "autoGeneratePhraseQueries": true
}

### Response
#### Success Response (200)
- **totalResults** (integer) - Total number of search results.
- **hits** (array) - List of search result objects.

#### Response Example
{
  "totalResults": -2147483648,
  "hits": []
}
```

--------------------------------

### POST /deployments/{deploymentIdentifier}/search

Source: https://help.heretto.com/en/heretto-deploy-api/deploy-api-endpoint-specification/search-pages

Searches all pages in a specific deployment using Apache Lucene parser syntax. Supports metadata filtering, drilldowns, and facet requests.

```APIDOC
## POST /deployments/{deploymentIdentifier}/search

### Description
Searches all pages in a deployment. Queries are parsed using Apache Lucene parser syntax. You can filter results based on metadata. The response contains highlights for the matches.

### Method
POST

### Endpoint
https://{organizationId}.deploy.heretto.com/v4/deployments/{deploymentIdentifier}/search

### Parameters
#### Path Parameters
- **deploymentIdentifier** (string) - Required - Deployment identifier

#### Query Parameters
- **audience** (string) - Optional - Name of an audience defined for this deployment.
- **token** (string) - Optional - Deploy API token

#### Request Body
- **queryString** (string) - Required - The query string, parsed according to the lucene query syntax.
- **drilldowns** (array[array]) - Optional - Filters files based on metadata.
- **refineToPaths** (array[string]) - Optional - A list of paths to refine the search to.
- **addPrefix** (boolean) - Optional - Expand the query with prefix and fuzzy matching. Default true.
- **includeExplanation** (boolean) - Optional - Include explanation of the query result ranking.
- **facetRequests** (array[array]) - Optional - Requests metadata facet information to be returned in the response.
- **startOffset** (integer) - Optional - The start offset for the search hits. Defaults to 0.
- **endOffset** (integer) - Optional - The end offset for the search hits. Defaults to 10.
- **hierarchical_facets** (boolean) - Optional - Return facet results as a hierarchy. Default false.
- **show_facets_missing_from_taxonomy** (boolean) - Optional - Show facets from the response if they are not defined in the taxonomy. Default false.
- **convertDoubleQuotesToStraight** (boolean) - Optional - Converts double quotes in the queryString to straight quotes. Default true.
- **autoGeneratePhraseQueries** (boolean) - Optional - Generate phrase queries from the queryString for adjacent terms. Default true.

### Response
#### Success Response (200)
- Returns search results
```

--------------------------------

### Heretto Deploy API JWT URL Parameter Authentication

Source: https://help.heretto.com/en/heretto-deploy-api/deploy-api-authentication

Authenticate API requests by appending a signed JWT as a URL parameter. The JWT should be added to the 'token' query parameter.

```text
https://thunderbird.deploy.heretto.com/v4/deployments/I9vA3KlK1331IYmEHhU/search?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWRpZW5jZSI6ImF1ZGllbmNlX2EifQ.x7KlW9Z5jS6ImF1ZGllbmNlX2Ei
```

--------------------------------

### Construct Search Endpoint URL

Source: https://help.heretto.com/en/heretto-deploy-api/deploy-api-authentication

Template for the search endpoint URL requiring organizationId and deploymentIdentifier variables.

```text
https://{organizationId}.deploy.heretto.com/v4/deployments/{deploymentIdentifier}/search
```

--------------------------------

### API Response Structure

Source: https://help.heretto.com/en/heretto-deploy-api/deploy-api-endpoint-specification/get-content

This JSON structure represents a successful response from the Heretto Deploy API when fetching deployment content. It details various fields including content, metadata, related links, and hierarchical information.

```json
{
  "content": "string",
  "title": "string",
  "href": "string",
  "outputclasses": [
    "string"
  ],
  "apiOperationMeta": {
    "apiSpecificationId": "string",
    "path": "string",
    "method": "string",
    "operationId": "string"
  },
  "metadata": [
    {
      "property1": "string",
      "property2": "string"
    }
  ],
  "relatedLinks": [
    {
      "title": "string",
      "href": "string",
      "shortDescription": "string",
      "binaryHref": "string",
      "id": "string",
      "type": "string",
      "outputclasses": [
        "string"
      ],
      "contentHref": "string"
    }
  ],
  "chunked_sections": [
    {
      "title": "string",
      "topicId": "string",
      "sys": {
        "uuid": "string"
      },
      "children": [
        {}
      ]
    }
  ],
  "previous": {
    "title": "string",
    "href": "string",
    "shortDescription": "string",
    "binaryHref": "string",
    "id": "string",
    "type": "string",
    "outputclasses": [
      "string"
    ],
    "contentHref": "string"
  },
  "next": {
    "title": "string",
    "href": "string",
    "shortDescription": "string",
    "binaryHref": "string",
    "id": "string",
    "type": "string",
    "outputclasses": [
      "string"
    ],
    "contentHref": "string"
  },
  "parent": {
    "title": "string",
    "href": "string",
    "shortDescription": "string",
    "binaryHref": "string",
    "id": "string",
    "type": "string",
    "outputclasses": [
      "string"
    ],
    "contentHref": "string"
  },
  "versions": [
    {
      "title": "string",
      "href": "string",
      "id": "string",
      "containedTopicHref": "string"
    }
  ],
  "breadcrumbs": [
    {
      "title": "string",
      "href": "string",
      "shortDescription": "string",
      "binaryHref": "string",
      "id": "string",
      "type": "string",
      "outputclasses": [
        "string"
      ],
      "contentHref": "string"
    }
  ],
  "children": [
    {
      "title": "string",
      "href": "string",
      "shortDescription": "string",
      "binaryHref": "string",
      "id": "string",
      "type": "string",
      "outputclasses": [
        "string"
      ],
      "contentHref": "string"
    }
  ],
  "sys": {
    "uuid": "string"
  },
  "audienceContent": true,
  "keywords": [
    "string"
  ],
  "shortDescription": "string",
  "standardMetadata": {
    "taxonomy": {
      "property1": {
        "humanReadable": "string",
        "value": "string",
        "values": [
          {
            "value": "string",
            "humanReadable": "string"
          }
        ]
      }
    }
  }
}
```

--------------------------------

### Heretto Deploy API Search Request Body

Source: https://help.heretto.com/en/heretto-deploy-api/deploy-api-endpoint-specification/search-pages

Defines the structure for search queries sent to the Heretto Deploy API. Use this to specify search terms, drilldowns, facets, and other search parameters.

```json
{
  "queryString": "string",
  "drilldowns": [
    [
      [
        "string"
      ]
    ]
  ],
  "refineToPaths": [
    "string"
  ],
  "addPrefix": true,
  "includeExplanation": true,
  "facetRequests": [
    [
      "string"
    ]
  ],
  "startOffset": -2147483648,
  "endOffset": -2147483648,
  "hierarchical_facets": true,
  "show_facets_missing_from_taxonomy": true,
  "convertDoubleQuotesToStraight": true,
  "autoGeneratePhraseQueries": true
}
```

--------------------------------

### Heretto Deploy API JWT Header Authentication

Source: https://help.heretto.com/en/heretto-deploy-api/deploy-api-authentication

Authenticate API requests using a signed JWT in the request header. The JWT must be signed with a JWT HS256 key and provided in the 'X-Deploy-API-Auth' header.

```curl
curl --location 'https://thunderbird.deploy.heretto.com/v4/deployments/I9vA3KlK1331IYmEHhU/search' \
--header 'X-Deploy-API-Auth: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWRpZW5jZSI6ImF1ZGllbmNlX2EifQ.x7KlW9Z5jS6ImF1ZGllbmNlX2Ei'
```

--------------------------------

### Configure JWT Header

Source: https://help.heretto.com/en/heretto-deploy-api/deploy-api-authentication

The standard header configuration for HS256 signed JWTs.

```json
{ "alg": "HS256", "typ": "JWT" }
```
Tokens:
Raw