{
  "opencollection": "1.0.0",
  "info": {
    "name": "Coveo Activity Activities IPX Configuration API",
    "version": "1.0.0"
  },
  "request": {
    "auth": {
      "type": "oauth2",
      "flow": "authorization_code",
      "authorizationUrl": "https://platform.cloud.coveo.com/oauth/authorize",
      "accessTokenUrl": "https://platform.cloud.coveo.com/oauth/token",
      "credentials": {
        "clientId": "{{clientId}}",
        "clientSecret": "{{clientSecret}}"
      }
    }
  },
  "items": [
    {
      "info": {
        "name": "IPX Configuration",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List All IPX Interface Configurations",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/ipxinterface/v1/interfaces",
            "params": [
              {
                "name": "organizationId",
                "value": "mycoveocloudv2organizationg8tp8wu3",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/)."
              },
              {
                "name": "filter",
                "value": "Store",
                "type": "query",
                "description": "A substring that must appear in a search interface configuration name for this configuration to appear in results."
              },
              {
                "name": "order",
                "value": "",
                "type": "query",
                "description": "The sort direction of the results.<br />Possible values:<br /> - `asc`: ascending order<br /> - `desc`: descending order"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "The 0-based number of the page of configurations to list."
              },
              {
                "name": "perPage",
                "value": "",
                "type": "query",
                "description": "The maximum number of configurations to include per page."
              }
            ]
          },
          "docs": "Lists the IPX interface configurations in a [Coveo organization](https://docs.coveo.com/en/185/)."
        },
        {
          "info": {
            "name": "Create IPX Interface Configuration",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/ipxinterface/v1/interfaces",
            "params": [
              {
                "name": "organizationId",
                "value": "mycoveocloudv2organizationg8tp8wu3",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/)."
              },
              {
                "name": "createPipelines",
                "value": "",
                "type": "query",
                "description": "If true, pipelines, conditions and models will be created for the IPX interface."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create an IPX interface configuration in a [Coveo organization](https://docs.coveo.com/en/185/)."
        },
        {
          "info": {
            "name": "List IPX Interface Configurations in Project",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/ipxinterface/v1/projects/interfaces",
            "params": [
              {
                "name": "organizationId",
                "value": "mycoveocloudv2organizationg8tp8wu3",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/)."
              },
              {
                "name": "filter",
                "value": "Store",
                "type": "query",
                "description": "A substring that must appear in a search interface configuration name for this configuration to appear in results."
              },
              {
                "name": "order",
                "value": "",
                "type": "query",
                "description": "The sort direction of the results.<br />Possible values:<br /> - `asc`: ascending order<br /> - `desc`: descending order"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "The 0-based number of the page of configurations to list."
              },
              {
                "name": "perPage",
                "value": "",
                "type": "query",
                "description": "The maximum number of configurations to include per page."
              },
              {
                "name": "projectId",
                "value": "",
                "type": "query",
                "description": "The id of the project to which the resource belongs."
              }
            ]
          },
          "docs": "Lists the IPX interface configurations in a [Coveo organization](https://docs.coveo.com/en/185/) and a [project](https://docs.coveo.com/en/n7ef0517/manage-an-organization/manage-projects)."
        },
        {
          "info": {
            "name": "Show IPX Interface Configuration",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/ipxinterface/v1/interfaces/:interfaceId",
            "params": [
              {
                "name": "organizationId",
                "value": "mycoveocloudv2organizationg8tp8wu3",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/)."
              },
              {
                "name": "interfaceId",
                "value": "123e4567-e89b-12d3-a456-426614174000",
                "type": "path",
                "description": "The unique identifier of the target search interface."
              }
            ]
          },
          "docs": "Shows an IPX interface configuration in a [Coveo organization](https://docs.coveo.com/en/185/)."
        },
        {
          "info": {
            "name": "Update IPX Interface Configuration",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/ipxinterface/v1/interfaces/:interfaceId",
            "params": [
              {
                "name": "organizationId",
                "value": "mycoveocloudv2organizationg8tp8wu3",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/)."
              },
              {
                "name": "interfaceId",
                "value": "123e4567-e89b-12d3-a456-426614174000",
                "type": "path",
                "description": "The unique identifier of the target search interface."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates an IPX interface configuration in a [Coveo organization](https://docs.coveo.com/en/185/)."
        },
        {
          "info": {
            "name": "Delete IPX Interface Configuration",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/ipxinterface/v1/interfaces/:interfaceId",
            "params": [
              {
                "name": "organizationId",
                "value": "mycoveocloudv2organizationg8tp8wu3",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/)."
              },
              {
                "name": "interfaceId",
                "value": "123e4567-e89b-12d3-a456-426614174000",
                "type": "path",
                "description": "The unique identifier of the target search interface."
              }
            ]
          },
          "docs": "Deletes an IPX interface configuration in a [Coveo organization](https://docs.coveo.com/en/185/)."
        },
        {
          "info": {
            "name": "Get Versions for an IPX Interface",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/ipxinterface/v1/interfaces/:interfaceId/versions",
            "params": [
              {
                "name": "organizationId",
                "value": "mycoveocloudv2organizationg8tp8wu3",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/)."
              },
              {
                "name": "interfaceId",
                "value": "123e4567-e89b-12d3-a456-426614174000",
                "type": "path",
                "description": "The unique identifier of the target search interface."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "The 0-based number of the page of versions to list."
              },
              {
                "name": "perPage",
                "value": "",
                "type": "query",
                "description": "The number of versions to include per page."
              },
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "A substring that must appear in a version label for this version to appear in results."
              },
              {
                "name": "order",
                "value": "",
                "type": "query",
                "description": "The sort direction of the versions based on the version number.<br />Possible values:<br /> - `asc`: ascending order<br /> - `desc`: descending order"
              }
            ]
          },
          "docs": "Get a list of versions of the [IPX](https://docs.coveo.com/en/n47d1000/) interface of a [Coveo organization](https://docs.coveo.com/en/185/)."
        },
        {
          "info": {
            "name": "Get an IPX Interface Version",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/ipxinterface/v1/interfaces/:interfaceId/versions/:versionNumber",
            "params": [
              {
                "name": "organizationId",
                "value": "mycoveocloudv2organizationg8tp8wu3",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/)."
              },
              {
                "name": "interfaceId",
                "value": "123e4567-e89b-12d3-a456-426614174000",
                "type": "path",
                "description": "The unique identifier of the target search interface."
              },
              {
                "name": "versionNumber",
                "value": "",
                "type": "path",
                "description": "The sequential number identifying a version."
              }
            ]
          },
          "docs": "Get information about a specific version of an [IPX](https://docs.coveo.com/en/n47d1000/) interface."
        },
        {
          "info": {
            "name": "Restore an IPX Interface Version",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/ipxinterface/v1/interfaces/:interfaceId/versions/:versionNumber/restore",
            "params": [
              {
                "name": "organizationId",
                "value": "mycoveocloudv2organizationg8tp8wu3",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/)."
              },
              {
                "name": "interfaceId",
                "value": "123e4567-e89b-12d3-a456-426614174000",
                "type": "path",
                "description": "The unique identifier of the target search interface."
              },
              {
                "name": "versionNumber",
                "value": "",
                "type": "path",
                "description": "The sequential number identifying a version."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Restore the current [IPX](https://docs.coveo.com/en/n47d1000/) interface to a specific version."
        },
        {
          "info": {
            "name": "Update an IPX Interface Version Label",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/ipxinterface/v1/interfaces/:interfaceId/versions/:versionNumber/label",
            "params": [
              {
                "name": "organizationId",
                "value": "mycoveocloudv2organizationg8tp8wu3",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/)."
              },
              {
                "name": "interfaceId",
                "value": "123e4567-e89b-12d3-a456-426614174000",
                "type": "path",
                "description": "The unique identifier of the target search interface."
              },
              {
                "name": "versionNumber",
                "value": "",
                "type": "path",
                "description": "The sequential number identifying a version."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update the label for a specific [IPX](https://docs.coveo.com/en/n47d1000/) interface version."
        },
        {
          "info": {
            "name": "Preview IPX Interface",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/ipxinterface/v1/interfaces/:interfaceId/preview",
            "params": [
              {
                "name": "organizationId",
                "value": "mycoveocloudv2organizationg8tp8wu3",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/)."
              },
              {
                "name": "interfaceId",
                "value": "123e4567-e89b-12d3-a456-426614174000",
                "type": "path",
                "description": "The unique identifier of the target search interface."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Generate the markup of an IPX interface in a [Coveo organization](https://docs.coveo.com/en/185/)."
        },
        {
          "info": {
            "name": "Get IPX Interface Builder",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/ipxinterface/v1/interfaces/:interfaceId/edit",
            "params": [
              {
                "name": "organizationId",
                "value": "mycoveocloudv2organizationg8tp8wu3",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/)."
              },
              {
                "name": "interfaceId",
                "value": "123e4567-e89b-12d3-a456-426614174000",
                "type": "path",
                "description": "The unique identifier of the target search interface."
              }
            ]
          },
          "docs": "Get the builder for an IPX interface in a [Coveo organization](https://docs.coveo.com/en/185/)."
        },
        {
          "info": {
            "name": "Get IPX Interface Login",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/ipxinterface/v1/interfaces/:interfaceId/login",
            "params": [
              {
                "name": "organizationId",
                "value": "mycoveocloudv2organizationg8tp8wu3",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/)."
              }
            ]
          },
          "docs": "Get the login page for an IPX interface in a [Coveo organization](https://docs.coveo.com/en/185/)."
        },
        {
          "info": {
            "name": "Get IPX Interface Search Token",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/ipxinterface/v1/interfaces/:interfaceId/token",
            "params": [
              {
                "name": "organizationId",
                "value": "mycoveocloudv2organizationg8tp8wu3",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/)."
              }
            ]
          },
          "docs": "Get the search token for an IPX interface in a [Coveo organization](https://docs.coveo.com/en/185/)."
        },
        {
          "info": {
            "name": "Get IPX Interface Pipelines",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/ipxinterface/v1/interfaces/:interfaceId/pipelines",
            "params": [
              {
                "name": "organizationId",
                "value": "mycoveocloudv2organizationg8tp8wu3",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/)."
              },
              {
                "name": "interfaceId",
                "value": "123e4567-e89b-12d3-a456-426614174000",
                "type": "path",
                "description": "The unique identifier of the target search interface."
              }
            ]
          },
          "docs": "Get the pipelines used by an IPX interface in a [Coveo organization](https://docs.coveo.com/en/185/) in the builder context."
        }
      ]
    }
  ],
  "bundled": true
}