openapi: 3.2.0 info: title: Ibm Api Connect Portal API contact: name: IBM url: https://www.ibm.com email: help@ibm.com license: name: tbd url: https://tbd.com x-refined-note: - x-ibm-name differs across the merged source definitions and was not carried version: '1.0' description: 'Operations tagged Portal across 2 of this provider''s published API definitions: ibm-api-connect-consumer-api-openapi.yml, ibm-api-connect-portal-admin-api-openapi.yml. Each path carries the servers of the definition it was published in.' tags: - name: Portal paths: /portal-chatbot: post: summary: Create a new AI Agent chat session description: Create a new chat session with the AI Agent operationId: portal_chatbot_chat parameters: - $ref: '#/components/parameters/consumer_org_url' security: - oauth: - org:view requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PortalChatbot' application/yaml: schema: $ref: '#/components/schemas/PortalChatbot' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/PortalChatbot' application/yaml: schema: $ref: '#/components/schemas/PortalChatbot' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Consumer apim base path /portal-chatbot/{chat-session}: parameters: - $ref: '#/components/parameters/chat-session' - $ref: '#/components/parameters/consumer_org_url' post: summary: Send message to AI Agent description: Send a message to the AI Agent and receive a response, or execute a plan operationId: portal_chatbot_chatById security: - oauth: - org:view requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PortalChatbot' application/yaml: schema: $ref: '#/components/schemas/PortalChatbot' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/PortalChatbot' application/yaml: schema: $ref: '#/components/schemas/PortalChatbot' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Consumer apim base path /catalogs/{org}/{catalog}/api/list: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' get: summary: Shows a list of apis from a site description: Show a list of apis of the provided org and catalog. operationId: api_list security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_api.html responses: '200': description: Successful output of the list apis command content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '403': description: Failure - unauthorized content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/api/get: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' get: summary: Get a specific api from a developer portal description: Get a specific api from the developer portal of the provided org and catalog. The id or name:version of a specific api needs to be provided. e.g. './apic --mode portaladmin api:get --server **api** --catalog **catalog** --org **org** my-api:2.0.0'. operationId: api_get security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_api.html parameters: - $ref: '#/components/parameters/api' responses: '200': description: Successful output of the get api command content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '403': description: Failure - unauthorized content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/api/get-document: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' get: summary: Get a specific entire api document from a developer portal description: Get a specific entire api document from the developer portal of the provided org and catalog. The id or name:version of a specific api needs to be provided. e.g. 'id-of-api-called-example-3' or 'example:3.0.0'. operationId: api_getDocument security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_api.html parameters: - $ref: '#/components/parameters/api' responses: '200': description: Successful output of the get-document api command content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '403': description: Failure - unauthorized content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/api/add-attachment: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' post: summary: Add an attachment for the given api description: Add an attachment for a api within the developer portal of the provided org and catalog. A api can hold 10 attachments. The id or name:version of a specific api needs to be provided. e.g. 'id-of-api-called-example-3' or 'example:3.0.0'. operationId: api_addAttachment security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_api.html parameters: - $ref: '#/components/parameters/api' - $ref: '#/components/parameters/attachment_name' - $ref: '#/components/parameters/attachment_description' requestBody: content: application/octet-stream: schema: type: string format: binary responses: '200': description: Successful add of the api attachment content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '403': description: Failure - unauthorized content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/api/add-tag: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' post: summary: Add a tag for the given api description: Add a tag for a api within the developer portal of the provided org and catalog. The id or name:version of a specific api needs to be provided. e.g. 'id-of-api-called-example-3' or 'example:3.0.0'. operationId: api_addTag security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_api.html parameters: - $ref: '#/components/parameters/api' - $ref: '#/components/parameters/tag_name' responses: '200': description: Successful add of the api tag content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '403': description: Failure - unauthorized content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/api/set-icon: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' put: summary: Set an icon image for the given api description: Set an icon image for a api within the developer portal of the provided org and catalog. The existing icon will be overwritten. The id or name:version of a specific api needs to be provided. e.g. 'id-of-api-called-example-3' or 'example:3.0.0'. operationId: api_setIcon security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_api.html parameters: - $ref: '#/components/parameters/api' - $ref: '#/components/parameters/icon_description' requestBody: content: application/octet-stream: schema: type: string format: binary responses: '200': description: Successful set of the api icon content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '403': description: Failure - unauthorized content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/apic-config/get: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' get: summary: Get the configuration object that the developer portal holds description: Get the configuration object that the developer portal holds that was sent by APIM. operationId: apic_config_get security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_apicconfig.html responses: '200': description: Successful output of the get apic config command content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '403': description: Failure - unauthorized content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/application/list: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' get: summary: Shows a list of applications from a site description: Show a list of applications of the provided org and catalog. operationId: application_list security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_application.html responses: '200': description: Successful output of the list applications command content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '403': description: Failure - unauthorized content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/application/get: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' get: summary: Get a specific application from a developer portal description: Get a specific application from the developer portal of the provided org and catalog. The id of a specific application needs to be provided. e.g. './apic --mode portaladmin application:get --server **api** --catalog **catalog** --org **org** my-first-application ' operationId: application_get security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_application.html parameters: - $ref: '#/components/parameters/application' responses: '200': description: Successful output of the get application command content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '403': description: Failure - unauthorized content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/consumer-org/list: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' get: summary: Shows a list of consumer orgs from a site description: Show a list of consumer orgs of the provided org and catalog. operationId: consumer_org_list security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_consumerorg.html responses: '200': description: Successful output of the list consumer orgs command content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '403': description: Failure - unauthorized content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/consumer-org/get: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' get: summary: Get a specific consumer org from a developer portal description: Get a specific consumer org from the developer portal of the provided org and catalog. The id of a specific consumer organization needs to be provided. e.g. './apic --mode portaladmin consumer-org:get --server **api** --catalog **catalog** --org **org** acme-org' operationId: consumer_org_get security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_consumerorg.html parameters: - $ref: '#/components/parameters/consumer-org' responses: '200': description: Successful output of the get consumer org command content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '403': description: Failure - unauthorized content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/content/export/{entity_type}: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/entity_type' post: summary: Export a tgz containing the site content description: Export a tgz containing the site content. You can export specific entity types and specific ids or you can generate a tar containing all content. Depending on your site's content please be advised that an export all can take a long time to complete. If called via the toolkit CLI, it will automatically poll the response every 30 seconds up to 25 minutes. operationId: content_createExport security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_content.html parameters: - $ref: '#/components/parameters/entity_ids' responses: '201': description: Successful create of the task content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '429': description: Task already exists content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/content/export/{task_id}/download: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/task_id' get: summary: When ready, streams a content export artifact description: When ready, streams a content export artifact back to the related task id that is provided in the arguments. operationId: content_getExport security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_content.html responses: '200': description: The export artifact stream. content: application/octet-stream: schema: type: string format: binary '404': description: This task and its related artifact could not be found. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '406': description: The task is not an export operation and therefore an artifact cannot be streamed. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '425': description: The artifact related to this task is still being processed. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/content/export/{task_id}/delete: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/task_id' delete: summary: If running, cancels a content export task description: If running, cancels the content export task and deletes any related artifacts that have been generated. operationId: content_deleteExport security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_content.html responses: '204': description: The task has been cancelled and it's artifacts deleted. '404': description: The task was not found. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/content/export/{task_id}/status: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/task_id' get: summary: Returns information about the status of this task description: Returns information related to the task id that is provided in the arguments. operationId: content_getExportStatus security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_content.html responses: '200': description: Task is ready to be obtained content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '202': description: Waiting on task to finish. content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '404': description: The task was not found. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '410': description: The task and its artifacts have expired. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/content/import: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' post: summary: Create a task that imports an archive of site content description: Creates a task that imports an archive of site content. The status of this task can be tracked with the /content/TASK_ID/status route. Depending on your site's content please be advised that an import can take a long time to complete. If called via the toolkit CLI, it will automatically poll the response every 30 seconds up to 25 minutes. operationId: custom_module_createImport externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_custom_module.html requestBody: content: application/octet-stream: schema: type: string format: binary responses: '201': description: Successful create of the import task content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '429': description: Task already exists content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/content/import/{task_id}: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/task_id' delete: summary: If running, cancels a content import task description: If running, cancels the content import task and deletes any related artifacts that have been generated. operationId: content_deleteImport security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_content.html responses: '204': description: The task has been cancelled and it's artifacts deleted. '404': description: The task was not found. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/content/import/{task_id}/status: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/task_id' get: summary: Returns information about the status of this task description: Returns information related to the task id that is provided in the arguments. operationId: content_getImportStatus security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_content.html responses: '200': description: Task is ready to be obtained content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '202': description: Waiting on task to finish. content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '404': description: The task was not found. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '410': description: The task and its artifacts have expired. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/content/list/{entity_type}: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/entity_type' get: summary: Lists all of the entities in your site for the given entity type and bundle description: Lists all of the entities in your site for the given entity type and bundle. operationId: content_list security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_content.html parameters: - $ref: '#/components/parameters/bundle' responses: '200': description: Task has completed. content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '403': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '404': description: The task was not found. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/content/list-types: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' get: summary: Lists allowed content types on your site description: Lists allowed content types on your site. operationId: content_listTypes security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_content.html responses: '200': description: Task has completed. content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '403': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '404': description: The task was not found. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/custom-module/export: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' post: summary: Create a task that exports an archive that contains the custom modules of a site description: You can create a task to export an archive of the custom modules of a site. You can then use that archive to quickly and simply override the custom modules on another site. operationId: custom_module_createExport externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_custom_module.html responses: '201': description: Successful create of the task content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '429': description: Task already exists content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/custom-module/export/{task_id}: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/task_id' get: summary: When ready, streams a custom module export artifact description: When ready, streams a custom module export artifact back to the related task id that is provided in the arguments. operationId: custom_module_getExport externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_custom_module.html responses: '200': description: A stream of the export artifact. content: application/octet-stream: schema: type: string format: binary '404': description: This task and its related artifact could not be found. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '406': description: The task is not an export operation and therefore an artifact cannot be streamed. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '425': description: The artifact related to this task is still being processed. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal delete: summary: If running, cancels a custom module export task description: If running, cancels the custom module export task and deletes any related artifacts that have been generated. operationId: custom_module_deleteExport externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_custom_module.html responses: '204': description: The task has been cancelled and it's artifacts deleted. '404': description: The task was not found. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/custom-module/export/{task_id}/status: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/task_id' get: summary: Returns information about the status of this task description: Returns information related to the task id that is provided in the arguments. operationId: custom_module_getExportStatus externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_custom_module.html responses: '200': description: Task is ready to be obtained content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '202': description: Waiting on task to finish. content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '404': description: The task was not found. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '410': description: The task and its artifacts have expired. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/custom-module/import: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/wait_cache' post: summary: Create a task that imports an archive that contains the custom modules of a site description: You can create a task to import an archive of the custom modules of a site. You can use the imported archive to quickly and simply override the custom modules for the specified site. operationId: postCatalogsByOrgByCatalogCustomModuleImport externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_custom_module.html requestBody: content: application/octet-stream: schema: type: string format: binary responses: '201': description: Successful create of the task content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '429': description: Task already exists content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal x-operation-id-source: normalized x-operation-id-original: custom_module_createImport servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/custom-module/import/{task_id}: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/task_id' delete: summary: If running, cancels a custom module import task description: If running, cancels the custom module import task and deletes any related artifacts that have been generated. operationId: custom_module_deleteImport externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_custom_module.html responses: '204': description: The task has been cancelled and it's artifacts deleted. '404': description: The task was not found. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/custom-module/import/{task_id}/status: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/task_id' get: summary: Get the result of the custom module import task description: Get the result of the custom module import task. If the import task has completed on the portal system, this command returns the result of the command. If the import task has not completed on the portal system, it returns the current status of the task. operationId: custom_module_getImportStatus externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_custom_module.html responses: '200': description: Output from portal cli command request content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '202': description: Waiting on task to finish. content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '404': description: The task was not found. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '410': description: The task and its result have expired. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/custom-library/import: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/wait_cache' post: summary: Create a task that imports an archive that contains the custom libraries of a… description: You can create a task to import an archive of the custom libraries of a site. You can use the imported archive to quickly and simply add custom libraries for the specified site. operationId: custom_library_createImport externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_custom_library.html requestBody: content: application/octet-stream: schema: type: string format: binary responses: '201': description: Successful create of the task content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '429': description: Task already exists content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/custom-library/import/{task_id}: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/task_id' delete: summary: If running, cancels a custom library import task description: If running, cancels the custom library import task and deletes any related artifacts that have been generated. operationId: custom_library_deleteImport externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_custom_library.html responses: '204': description: The task has been cancelled and it's artifacts deleted. '404': description: The task was not found. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/custom-library/import/{task_id}/status: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/task_id' get: summary: Get the result of the custom library import task description: Get the result of the custom library import task. If the import task has completed on the portal system, this command returns the result of the command. If the import task has not completed on the portal system, it returns the current status of the task. operationId: custom_library_getImportStatus externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_custom_library.html responses: '200': description: Output from portal cli command request content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '202': description: Waiting on task to finish. content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '404': description: The task was not found. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '410': description: The task and its result have expired. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/custom-theme/export: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' post: summary: Create a task that exports an archive that contains the custom themes of a site description: You can create a task to export an archive of the custom themes of a site. You can then use that archive to quickly and simply override the custom themes on another site. operationId: custom_theme_createExport externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_custom_theme.html responses: '201': description: Successful create of the task content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '429': description: Task already exists content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/custom-theme/export/{task_id}: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/task_id' get: summary: When ready, streams a custom theme export artifact description: When ready, streams a custom theme export artifact back to the related task id that is provided in the arguments. operationId: custom_theme_getExport externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_custom_theme.html responses: '200': description: A stream of the export artifact. content: application/octet-stream: schema: type: string format: binary '404': description: This task and its related artifact could not be found. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '406': description: The task is not an export operation and therefore an artifact cannot be streamed. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '425': description: The artifact related to this task is still being processed. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal delete: summary: If running, cancels a custom theme export task description: If running, cancels the custom theme export task and deletes any related artifacts that have been generated. operationId: custom_theme_deleteExport externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_custom_theme.html responses: '204': description: The task has been cancelled and it's artifacts deleted. '404': description: The task was not found. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/custom-theme/export/{task_id}/status: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/task_id' get: summary: Returns information about the status of this task description: Returns information related to the task id that is provided in the arguments. operationId: custom_theme_getExportStatus externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_custom_theme.html responses: '200': description: Task is ready to be obtained content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '202': description: Waiting on task to finish. content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '404': description: The task was not found. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '410': description: The task and its artifacts have expired. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/custom-theme/import: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/wait_cache' post: summary: Create a task that imports an archive that contains the custom themes of a site description: You can create a task to import an archive of the custom themes of a site. You can use the imported archive to quickly and simply override the custom themes for the specified site. operationId: custom_theme_createImport externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_custom_theme.html requestBody: content: application/octet-stream: schema: type: string format: binary responses: '201': description: Successful create of the task content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '429': description: Task already exists content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/custom-theme/import/{task_id}: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/task_id' delete: summary: Cancels a running custom theme import task description: Cancels the custom theme import task and deletes any generated artifacts. operationId: custom_theme_deleteImport externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_custom_theme.html responses: '204': description: The task has been cancelled and it's artifacts deleted. '404': description: The task was not found. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/custom-theme/import/{task_id}/status: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/task_id' get: summary: Get the result of the custom theme import task description: Get the result of the custom theme import task. If the import task has completed on the portal system, this command returns the result of the command. If the import task has not completed on the portal system, it returns the current status of the task. operationId: custom_theme_getImportStatus externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_custom_theme.html responses: '200': description: Task has completed. content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '202': description: Waiting on task to finish. content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '404': description: The task was not found. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '410': description: The task and its result have expired. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/custom-translation/export: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' post: summary: Create a task that exports an archive that contains the custom translation of a… description: You can create a task to export an archive of the custom translation of a site. You can then use that archive to quickly and simply override the custom translations on another site. operationId: custom_translation_createExport security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_custom_translation.html parameters: - $ref: '#/components/parameters/langcodes' responses: '201': description: Successful create of the task content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '429': description: Task already exists content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/custom-translation/export/{task_id}: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/task_id' get: summary: When ready, streams a custom translation export artifact description: When ready, streams a custom translation export artifact back to the related task id that is provided in the arguments. operationId: custom_translation_getExport security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_custom_translation.html responses: '200': description: The export artifact stream. content: application/octet-stream: schema: type: string format: binary '404': description: This task and its related artifact could not be found. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '406': description: The task is not an export operation and therefore an artifact cannot be streamed. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '425': description: The artifact related to this task is still being processed. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal delete: summary: If running, cancels a custom translation export task description: If running, cancels the custom translation export task and deletes any related artifacts that have been generated. operationId: custom_translation_deleteExport security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_custom_translation.html responses: '204': description: The task has been cancelled and it's artifacts deleted. '404': description: The task was not found. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/custom-translation/export/{task_id}/status: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/task_id' get: summary: Returns information about the status of this task description: Returns information related to the task id that is provided in the arguments. operationId: custom_translation_getExportStatus security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_custom_translation.html responses: '200': description: Task is ready to be obtained content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '202': description: Waiting on task to finish. content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '404': description: The task was not found. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '410': description: The task and its artifacts have expired. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/custom-translation/import: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' post: summary: Create a task that imports an archive that contains the custom translations of… description: You can create a task to import an archive of the custom translations of a site. You can use the imported archive to quickly and simply override the custom translations for the specified site. operationId: custom_translation_createImport security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_custom_translation.html requestBody: content: application/octet-stream: schema: type: string format: binary responses: '201': description: Successful create of the task content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '429': description: Task already exists content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/custom-translation/import/{task_id}: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/task_id' delete: summary: If running, cancels a custom translation import task description: If running, cancels the custom translation import task and deletes any related artifacts that have been generated. operationId: custom_translation_deleteImport security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_custom_translation.html responses: '204': description: The task has been cancelled and it's artifacts deleted. '404': description: The task was not found. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/custom-translation/import/{task_id}/status: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/task_id' get: summary: Get the result of the custom translation import task description: Get the result of the custom translation import task. If the import task has completed on the portal system, this command returns the result of the command. If the import task has not completed on the portal system, it returns the current status of the task. operationId: custom_translation_getImportStatus security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_custom_translation.html responses: '200': description: Output from portal cli command request content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '202': description: Waiting on task to finish. content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '404': description: The task was not found. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '410': description: The task and its result have expired. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/export-entity: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' get: summary: List export entities description: List export entities within your Developer Portal. Export Entities contain a defined list of content to be exported when launched. operationId: export_entity_list security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_export_entity.html responses: '200': description: The creation of an export entities content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '403': description: Failure - unauthorized content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal put: summary: Create an export entity description: Create a new export entity. This export entity can be populated with content which can subsequently be exported. operationId: export_entity_create security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_export_entity.html parameters: - $ref: '#/components/parameters/export_entity_name' responses: '201': description: Successful create of an export entity content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '403': description: Failure - unauthorized content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/export-entity/{export_entity_id}: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/export_entity_id' get: summary: Get an export entity description: Get an export entity by its ID, which will list the content that will be exported as part of this export entity. operationId: export_entity_get security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_export_entity.html responses: '200': description: A list of content within the export entity content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '403': description: Failure - unauthorized content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal delete: summary: Delete an export entity description: Delete an export entity by its ID. operationId: export_entity_delete security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_export_entity.html responses: '200': description: The export entity has been successfully deleted content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '403': description: Failure - unauthorized content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/export-entity/{export_entity_id}/add-content: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/export_entity_id' post: summary: Add content to an export entity description: Add content to an existing export entity. Provide the content type and IDs that you wish to add to this export entity. operationId: export_entity_addContent security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_export_entity.html parameters: - $ref: '#/components/parameters/entity_ids' - $ref: '#/components/parameters/entity_type_query' responses: '200': description: Content succesfully added to export entity content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '403': description: Failure - unauthorized content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/export-entity/{export_entity_id}/remove-content: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/export_entity_id' post: summary: Remove content from an export entity description: Remove content from an export entity. Provide the content type and IDs that you wish to remove from this export entity. operationId: export_entity_removeContent security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_export_entity.html parameters: - $ref: '#/components/parameters/entity_ids' - $ref: '#/components/parameters/entity_type_query' responses: '200': description: Content successfully removed from export entity content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '403': description: Failure - unauthorized content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/export-entity/{export_entity_id}/launch: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/export_entity_id' post: summary: Launch a export entity description: Launch an export entity which will create an export tgz of all the entities contained in the export. If called via the toolkit CLI, it will automatically poll the response every 30 seconds up to 25 minutes. operationId: export_entity_launchExport security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_export_entity.html responses: '201': description: Successful create of the task content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '429': description: Task already exists content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/export-entity/{task_id}/download: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/task_id' get: summary: When ready, streams a content export artifact generated from an export entity description: When ready, streams a content export artifact generated from an export entity back to the related task id that is provided in the arguments. operationId: export_entity_getLaunchExport security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_export_entity.html responses: '200': description: The export artifact stream. content: application/octet-stream: schema: type: string format: binary '404': description: This task and its related artifact could not be found. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '406': description: The task is not an export operation and therefore an artifact cannot be streamed. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '425': description: The artifact related to this task is still being processed. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/export-entity/{task_id}/delete: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/task_id' delete: summary: If running, cancels a export entity launch export task description: If running, cancels a export entity launch export task and deletes any related artifacts that have been generated. operationId: export_entity_deleteLaunchExport security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_export_entity.html responses: '204': description: The task has been cancelled and it's artifacts deleted. '404': description: The task was not found. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/export-entity/{task_id}/status: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/task_id' get: summary: Returns information about the status of this task description: Returns information related to the task id that is provided in the arguments. operationId: export_entity_getLaunchExportStatus security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_export_entity.html responses: '200': description: Task is ready to be obtained content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '202': description: Waiting on task to finish. content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '404': description: The task was not found. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '410': description: The task and its artifacts have expired. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /service/custom-webserver-page: parameters: - $ref: '#/components/parameters/portal_service_name' - $ref: '#/components/parameters/page_type' get: summary: Get the HTML for a web server page description: Get the web server HTML content of a specific web server page (index, 404, 40x, 50x). operationId: custom_webserver_page_get security: - oauth: - org:view externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_custom_webserver_page.html responses: '200': description: Successful response. content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '404': description: The resource was not found. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal delete: summary: Delete the custom HTML for a web server page description: Delete the custom web server HTML content of a specific web server page (index, 404, 40x, 50x). (Will fallback to a default.) operationId: custom_webserver_page_delete security: - oauth: - org:view externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_custom_webserver_page.html responses: '200': description: Successful response. content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '404': description: The resource was not found. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal post: summary: Set a custom HTML page for a web server page type description: Set the custom web server HTML content of a specific web server page (index, 404, 40x, 50x). Maximum size of 8 MB. operationId: custom_webserver_page_set security: - oauth: - org:view externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_custom_webserver_page.html requestBody: content: application/octet-stream: schema: type: string format: binary responses: '200': description: Successful response. content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '404': description: The resource was not found. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/site/check: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' get: summary: Run a platform check against a portal site description: Performs filesystem, database and API Manager checks against a portal site. This command is useful when trying to identify platform related problems if you are having issues with your portal site. operationId: site_check security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_site.html responses: '200': description: Task has completed. content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '404': description: The task was not found. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/site/content-refresh: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' put: summary: Triggers a site level content refresh of the Developer Portal configuration… description: Triggers a site level content refresh of the Developer Portal configuration from API Manager. operationId: site_contentRefresh security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_site.html responses: '200': description: Task has completed. content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '404': description: The task was not found. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/site/content-refresh/status: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' get: summary: Gets the status of the latest site level content refresh of the Developer Portal description: Gets the status of the latest site level content refresh of the Developer Portal. operationId: site_contentRefreshStatus security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_site.html responses: '200': description: Task has completed. content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '404': description: The task was not found. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/site/export: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' post: summary: Create a task that exports an archive that contains the entire make-up of a site description: You can create a task to export an archive of the entire make-up of a site. You can then use that archive to quickly and simply override another site's content and configuration to make them identical. operationId: site_createExport security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_site.html responses: '201': description: Successful create of the task content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '429': description: Task already exists content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/site/export/{task_id}: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/task_id' get: summary: When ready, streams a site export artifact description: When ready, streams a site export artifact back to the related task id that is provided in the arguments. operationId: site_getExport security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_site.html responses: '200': description: The export artifact stream. content: application/octet-stream: schema: type: string format: binary '404': description: This task and its related artifact could not be found. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '406': description: The task is not an export operation and therefore an artifact cannot be streamed. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '425': description: The artifact related to this task is still being processed. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal delete: summary: If running, cancels a site export task description: If running, cancels the site export task and deletes any related artifacts that have been generated. operationId: site_deleteExport security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_site.html responses: '204': description: The task has been cancelled and it's artifacts deleted. '404': description: The task was not found. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/site/export/{task_id}/status: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/task_id' get: summary: Returns information about the status of this task description: Returns information related to the task id that is provided in the arguments. operationId: site_getExportStatus security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_site.html responses: '200': description: Task is ready to be obtained content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '202': description: Waiting on task to finish. content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '404': description: The task was not found. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '410': description: The task and its artifacts have expired. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/site/import: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' post: summary: Create a task that imports an archive that contains the make-up of a site description: You can create a task to import an archive of the make-up of a site. You can use the imported archive to quickly and simply override the site config, content and custom modules and themes for the specified site. operationId: site_createImport security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_site.html requestBody: content: application/octet-stream: schema: type: string format: binary responses: '201': description: Successful create of the task content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '429': description: Task already exists content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/site/import/{task_id}: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/task_id' delete: summary: If running, cancels a site import task description: If running, cancels the site import task and deletes any related artifacts that have been generated. operationId: site_deleteImport security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_site.html responses: '204': description: The task has been cancelled and it's artifacts deleted. '404': description: The task was not found. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/site/import/{task_id}/status: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/task_id' get: summary: Get the result of the site import task description: Get the result of the site import task. If the import task has completed on the portal system, this command returns the result of the command. If the import task has not completed on the portal system, it returns the current status of the task. operationId: site_getImportStatus security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_site.html responses: '200': description: Output from portal cli command request content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '202': description: Waiting on task to finish. content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '404': description: The task was not found. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '410': description: The task and its result have expired. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/site/login-link: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' get: summary: Gets an admin login link for a specific Portal site description: Returns a one time login link for the Drupal admin account for the site specified by org and catalog parameters operationId: site_loginLink security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_site.html responses: '200': description: Task has completed. content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '404': description: The task was not found. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/site/state: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' get: summary: Obtain the current state of a portal site description: Returns the state of a portal site. This command is useful as a general health check analysis of the portal site. operationId: site_state security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_site.html responses: '200': description: An output of the state of the portal site content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '404': description: The task was not found. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/entity/count: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' get: summary: Shows a count of entities from a site description: Show a count of entities of the provided org and catalog. operationId: entity_count security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_entity.html responses: '200': description: Successful output of the entity count command content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '403': description: Failure - unauthorized content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/forums/disable: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' post: summary: Disable the forum module for a given site description: Removes all forums vocabulary taxonomy terms before disabling the forum module for a given site. operationId: forums_disable externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_forums.html responses: '200': description: Output from portal cli command request content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '403': description: Failure - unauthorized content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/forums/enable: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' post: summary: Enable the forum module for a given site description: Enables the forum module for a given site. operationId: forums_enable externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_forums.html responses: '200': description: Output from portal cli command request content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '403': description: Failure - unauthorized content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/security/clearbans: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' get: summary: Clear all bans for a site description: Clear any existing User/IP bans. operationId: security_clearbans security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_security.html responses: '200': description: Successful output of the clearbans security command content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '403': description: Failure - unauthorized content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/drupal-config: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' get: summary: Get the Config object description: Get the Config object or a specific config key value. operationId: drupal_config_get security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_drupal_config.html parameters: - $ref: '#/components/parameters/config_name' - $ref: '#/components/parameters/config_key_optional' responses: '200': description: Task has completed. content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '404': description: The task was not found. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal delete: summary: Delete the Config object description: Delete the Config object or a specific config key. operationId: drupal_config_delete security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_drupal_config.html parameters: - $ref: '#/components/parameters/config_name' - $ref: '#/components/parameters/config_key_optional' responses: '200': description: Task has completed. content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '404': description: The task was not found. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal post: summary: Set a config value description: Can set a new config value or update an already existing key-value. operationId: drupal_config_set security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_drupal_config.html parameters: - $ref: '#/components/parameters/config_name' - $ref: '#/components/parameters/config_key' - $ref: '#/components/parameters/config_value' responses: '200': description: Task has completed. content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '404': description: The task was not found. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/drupal-config/list: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' get: summary: List the config names by prefix description: List the config names by prefix or provide no prefix to see all. operationId: drupal_config_list security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_drupal_config.html parameters: - $ref: '#/components/parameters/prefix' responses: '200': description: Task has completed. content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '404': description: The task was not found. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/drupal-state: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' get: summary: Get the State key description: Get the State key value. operationId: drupal_state_get security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_drupal_state.html parameters: - $ref: '#/components/parameters/state_key' responses: '200': description: Successful response. content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '404': description: The resource was not found. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal delete: summary: Delete the State key description: Delete the specific state key. operationId: drupal_state_delete security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_drupal_state.html parameters: - $ref: '#/components/parameters/state_key' responses: '200': description: Successful response. content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '404': description: The resource was not found. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal post: summary: Set a state key value description: Can set a new state value or update an already existing key-value. operationId: drupal_state_set security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_drupal_state.html parameters: - $ref: '#/components/parameters/state_key' - $ref: '#/components/parameters/state_value' - $ref: '#/components/parameters/input_format' responses: '200': description: Successful response. content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '404': description: The resource was not found. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/maintenance/status: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' get: summary: Gets the maintenance mode for the given Developer Portal description: Gets maintenance mode on the Developer Portal installed within this org and catalog. operationId: maintenance_status security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapim_portal_cli_cmd_maintenance.html responses: '200': description: The maintenance status of this Developer Portal. content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '404': description: The task was not found. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/maintenance/enable: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' put: summary: Enables maintenance mode for the given Developer Portal description: Enables maintenance mode on the Developer Portal installed within this org and catalog. operationId: maintenance_enable security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapim_portal_cli_cmd_maintenance.html responses: '200': description: Site maintenance has been enabled. content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '404': description: The task was not found. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/maintenance/disable: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' put: summary: Disables maintenance mode for the given Developer Portal description: Disables maintenance mode on the Developer Portal installed within this org and catalog. operationId: maintenance_disable security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapim_portal_cli_cmd_maintenance.html responses: '200': description: Site maintenance has been disabled. content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '404': description: The task was not found. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/maintenance/search-api-index-status: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' get: summary: Prints the search API index status for a Developer Portal description: Prints the search API index status for a Developer Portal. operationId: maintenance_searchApiIndexStatus security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapim_portal_cli_cmd_maintenance.html responses: '200': description: The status of the Search API Index. content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '404': description: The task was not found. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/maintenance/rebuild-node-access: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' put: summary: Rebuilds the node access table for a Developer Portal description: Rebuilds the node access table for a Developer Portal, which ensures the correct users can access particular content. operationId: maintenance_rebuildNodeAccess security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapim_portal_cli_cmd_maintenance.html responses: '200': description: The node access table will be rebuilt. content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '404': description: The task was not found. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/maintenance/search-api-index-rebuild: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' put: summary: Rebuilds and reindexes the search API index for a Developer Portal description: 'Rebuilds and reindexes the search API index for a Developer Portal. NOTE: this command triggers the reindex in the background, and reindexing can take a long time. You can track the index status with maintenance:search-api-index-status' operationId: maintenance_searchApiIndexRebuild security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapim_portal_cli_cmd_maintenance.html responses: '200': description: The Search API Index will be rebuilt. content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '404': description: The task was not found. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/site-config/export: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' post: summary: Create a task that exports an archive that contains the configuration of a site description: You can create a task to export an archive of the configuration of a site. You can then use that archive to quickly and simply override the configuration on another site. operationId: site_config_createExport externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_site_config.html responses: '201': description: Successful create of the task content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '429': description: Task already exists content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/site-config/export/{task_id}: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/task_id' get: summary: When ready, streams a site configuration export artifact description: When ready, streams a site configuration export artifact back to the related task id that is provided in the arguments. operationId: site_config_getExport externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_site_config.html responses: '200': description: A stream of the export artifact. content: application/octet-stream: schema: type: string format: binary '404': description: This task and its related artifact could not be found. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '406': description: The task is not an export operation and therefore an artifact cannot be streamed. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '425': description: The artifact related to this task is still being processed. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal delete: summary: If running, cancels a site configuration export task description: If running, cancels the site configuration export task and deletes any related artifacts that have been generated. operationId: site_config_deleteExport externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_site_config.html responses: '204': description: The task has been cancelled and it's artifacts deleted. '404': description: The task was not found. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/site-config/export/{task_id}/status: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/task_id' get: summary: Returns information about the status of this task description: Returns information related to the task id that is provided in the arguments. operationId: site_config_getExportStatus externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_site_config.html responses: '200': description: Task is ready to be obtained content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '202': description: Waiting on task to finish. content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '404': description: The task was not found. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '410': description: The task and its artifacts have expired. content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/site-config/import: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' post: summary: Create a task that imports an archive that contains the configuration of a site description: You can create a task to import an archive of the configuration of a site. You can use the imported archive to quickly and simply override the configuration for the specified site. operationId: site_config_createImport externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_site_config.html requestBody: content: application/octet-stream: schema: type: string format: binary responses: '201': description: Successful create of the task content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '429': description: Task already exists content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/site-config/import/{task_id}: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/task_id' delete: summary: Cancels a running site configuration import task description: Cancels the site configuration import task and deletes any generated artifacts. operationId: site_config_deleteImport externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_site_config.html responses: '204': description: The task has been cancelled and it's artifacts deleted. '404': description: The task was not found. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/site-config/import/{task_id}/status: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/task_id' get: summary: Get the result of the site configuration import task description: Get the result of the site configuration import task. If the import task has completed on the portal system, this command returns the result of the command. If the import task has not completed on the portal system, it returns the current status of the task. operationId: site_config_getImportStatus externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_site_config.html responses: '200': description: Task has completed. content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '202': description: Waiting on task to finish. content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '404': description: The task was not found. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '410': description: The task and its artifacts have expired. content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/queue: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' get: summary: Shows queued and locked platform related tasks for a Developer Portal description: Shows queued and locked platform related tasks for a Developer Portal, including Developer Portal creates, restores, upgrades, snapshots, crons etc. operationId: queue_get security: - oauth: - org:view externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_queue.html responses: '200': description: A list of queued tasks for the given Developer Portal content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '404': description: The task was not found. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /service/backups/list: get: summary: List the backups present on the remote backup server description: Lists all the backups that are currently present on the remote backup server, if one has been set. operationId: backups_list externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_backups.html parameters: - $ref: '#/components/parameters/portal_service_name' responses: '200': description: Successful output of the list backups command content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '403': description: Failure - unauthorized content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /service/platforms/list: get: summary: List the platforms present on the portal service description: Lists all the platforms that are currently present on the Portal service. operationId: platforms_list externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_platforms.html parameters: - $ref: '#/components/parameters/portal_service_name' responses: '200': description: Successful output of the list platforms command content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '403': description: Failure - unauthorized content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/product/list: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' get: summary: Shows a list of products from a site description: Show a list of products of the provided org and catalog. operationId: product_list security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_product.html responses: '200': description: Successful output of the list products command content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '403': description: Failure - unauthorized content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/product/get: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' get: summary: Get a specific product from a developer portal description: Get a specific product from the developer portal of the provided org and catalog. The id or name:version of a specific product needs to be provided. e.g. './apic --mode portaladmin product:get --server **api** --catalog **catalog** --org **org** example:3.0.0'. operationId: product_get security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_product.html parameters: - $ref: '#/components/parameters/product' responses: '200': description: Successful output of the get product command content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '403': description: Failure - unauthorized content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/product/get-document: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' get: summary: Get a specific entire product document from a developer portal description: Get a specific entire product document from the developer portal of the provided org and catalog. The id or name:version of a specific api needs to be provided. e.g. 'id-of-api-called-example-3' or 'example:3.0.0'. operationId: product_getDocument security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_product.html parameters: - $ref: '#/components/parameters/product' responses: '200': description: Successful output of the get product document command content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '403': description: Failure - unauthorized content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/product/add-attachment: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' post: summary: Add an attachment for the given product description: Add an attachment for a product within the developer portal of the provided org and catalog. A product can hold 10 attachments. The id or name:version of a specific product needs to be provided. e.g. 'id-of-api-called-example-3' or 'example:3.0.0'. operationId: product_addAttachment security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_product.html parameters: - $ref: '#/components/parameters/product' - $ref: '#/components/parameters/attachment_name' - $ref: '#/components/parameters/attachment_description' requestBody: content: application/octet-stream: schema: type: string format: binary responses: '200': description: Successful add of the product attachment content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '403': description: Failure - unauthorized content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/product/add-tag: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' post: summary: Add a tag for the given product description: Add a tag for a product within the developer portal of the provided org and catalog. The id or name:version of a specific product needs to be provided. e.g. 'id-of-api-called-example-3' or 'example:3.0.0'. operationId: product_addTag security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_product.html parameters: - $ref: '#/components/parameters/product' - $ref: '#/components/parameters/tag_name' responses: '200': description: Successful add of the product tag content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '403': description: Failure - unauthorized content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/product/set-icon: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' put: summary: Set an icon image for the given product description: Set an icon image for a product within the developer portal of the provided org and catalog. The existing icon will be overwritten. The id or name:version of a specific product needs to be provided. e.g. 'id-of-api-called-example-3' or 'example:3.0.0'. operationId: product_setIcon security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_product.html parameters: - $ref: '#/components/parameters/product' - $ref: '#/components/parameters/icon_description' requestBody: content: application/octet-stream: schema: type: string format: binary responses: '200': description: Successful set of the product icon content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '403': description: Failure - unauthorized content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /service/list: get: summary: List the Portal service description: Lists the Portal service currently installed. operationId: service_list security: - oauth: - org:view externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_service.html parameters: - $ref: '#/components/parameters/portal_service_name' responses: '200': description: Successful output of the list service command content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '403': description: Failure - unauthorized content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /service/content-refresh: put: summary: Triggers a cloud level content refresh of the Developer Portal Service… description: Triggers a cloud level content refresh of the Developer Portal Service configuration from API Manager. operationId: service_contentRefresh security: - oauth: - org:view externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_service.html parameters: - $ref: '#/components/parameters/portal_service_name' responses: '200': description: Successful output of the service content refresh command content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '403': description: Failure - unauthorized content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /service/sites/check: get: summary: Run a platform check against all portal sites present on a portal service description: Performs filesystem, database and API Manager checks against all portal sites on a given portal service. This command is useful when trying to identify platform related problems on one of more of your portal sites. operationId: sites_check security: - oauth: - org:view externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_sites.html parameters: - $ref: '#/components/parameters/portal_service_name' responses: '200': description: Successful output of the check sites command content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '403': description: Failure - unauthorized content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /service/sites/list: get: summary: List the sites present on the Portal service description: Lists all the sites that are currently present on the Portal service. operationId: sites_list externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_sites.html parameters: - $ref: '#/components/parameters/portal_service_name' responses: '200': description: Successful output of the list sites command content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '403': description: Failure - unauthorized content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /service/sites/reset-upgrade-attempts: put: summary: Resets the Developer Portal site upgrade attempts description: Resets the Developer Portal site upgrade attempts. Useful when upgrade has been attempted multiple times and has failed. operationId: sites_resetUpgradeAttempts security: - oauth: - org:view externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_sites.html parameters: - $ref: '#/components/parameters/portal_service_name' responses: '200': description: A notification of upgrade attempts being reset. content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '403': description: Failure - unauthorized content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /service/factory-reset: delete: summary: Factory resets the Developer Portal description: Performs a factory reset of the Developer Portal, deleting the portal service and all portal sites. This command is irreversible - please ensure you have backups configured. operationId: factory_reset_singletonDel security: - oauth: - org:view externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_factory_reset.html parameters: - $ref: '#/components/parameters/portal_service_endpoint' - $ref: '#/components/parameters/execute_reset' responses: '200': description: Output from portal cli command request content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '403': description: Failure - unauthorized content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /service/ip-security-enabled: post: summary: Enable or disable IP security functionality within the Developer Portal operationId: ip_security_enabled_update security: - oauth: - org:view externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_ip_security_enabled.html parameters: - $ref: '#/components/parameters/portal_service_name' - $ref: '#/components/parameters/ip_security_enabled' responses: '200': description: Successful output message of the security functionality being set content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '403': description: Failure - unauthorized content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /service/queue/list: get: summary: Shows queued and locked platform related tasks across all Developer Portals description: Shows queued and locked platform related tasks across all Developer Portal, including Developer Portal creates, restores, upgrades, snapshots, crons etc. operationId: queue_list security: - oauth: - org:view externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_queue.html parameters: - $ref: '#/components/parameters/portal_service_name' responses: '200': description: A list of queued tasks across all Developer Portals content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '404': description: The task was not found. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /service/php-memory/list: get: summary: List the PHP memory limit on the platform description: Lists the PHP memory_limit setting on the portal platform. operationId: php_memory_list security: - oauth: - org:view externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_phpmemory.html parameters: - $ref: '#/components/parameters/portal_service_name' responses: '200': description: Successful output of the php memory limits content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '403': description: Failure - unauthorized content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /service/php-memory/update: post: summary: Set the PHP memory limit on the portal platform description: Sets the PHP memory limit on the portal platform for both admin and web containers operationId: php_memory_update security: - oauth: - org:view externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_phpmemory.html parameters: - $ref: '#/components/parameters/portal_service_name' - $ref: '#/components/parameters/memory_value' responses: '200': description: Logs of the CLI command content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '403': description: Failure - unauthorized content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /service/ip-allowlist/add: post: summary: Add IP(s) to the allowlist operationId: ip_allowlist_add security: - oauth: - org:view externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_service_ip_allowlist.html parameters: - $ref: '#/components/parameters/portal_service_name' - $ref: '#/components/parameters/ips' responses: '200': description: Output from portal cli command request content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '403': description: Failure - unauthorized content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /service/ip-allowlist/remove: post: summary: Remove IP(s) from the allowlist operationId: ip_allowlist_remove security: - oauth: - org:view externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_service_ip_allowlist.html parameters: - $ref: '#/components/parameters/portal_service_name' - $ref: '#/components/parameters/ips' responses: '200': description: Output from portal cli command request content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '403': description: Failure - unauthorized content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /service/ip-allowlist: delete: summary: Remove all IPs from the allowlist description: Remove all IPs from the allowlist. operationId: ip_allowlist_singletonDel security: - oauth: - org:view externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_service_ip_allowlist.html parameters: - $ref: '#/components/parameters/portal_service_name' responses: '200': description: Output from portal cli command request content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '403': description: Failure - unauthorized content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /service/ip-allowlist/list: get: summary: List IP(s) currently on the allowlist description: List IP(s) currently on the allowlist. operationId: ip_allowlist_list security: - oauth: - org:view externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_service_ip_allowlist.html parameters: - $ref: '#/components/parameters/portal_service_name' responses: '200': description: Output from portal cli command request content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '403': description: Failure - unauthorized content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/modules/list: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' get: summary: Shows a list of available modules description: Show a list of modules for the portal of the provided org and catalog. operationId: modules_list security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_modules.html parameters: - $ref: '#/components/parameters/status' - $ref: '#/components/parameters/package' - $ref: '#/components/parameters/no-core' - $ref: '#/components/parameters/core' - $ref: '#/components/parameters/custom' responses: '200': description: Successful output of the list modules command content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '403': description: Failure - unauthorized content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/modules/enable: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' post: summary: Enable one or more module description: Enable one or more module by providing a comma-separated list. operationId: modules_enable security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_modules.html parameters: - $ref: '#/components/parameters/modules' responses: '200': description: Successful output of the enable module(s) command content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '403': description: Failure - unauthorized content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/modules/disable: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' post: summary: Disable one or more modules and their dependent modules description: Disable one or more modules and their dependent modules. The provided list of modules must be comma-separated. operationId: modules_disable security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_modules.html parameters: - $ref: '#/components/parameters/modules' responses: '200': description: Successful output of the disable module(s) command content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '403': description: Failure - unauthorized content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/modules/delete: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' delete: summary: Deletes one or more modules description: Deletes one or more modules. The provided list of modules must be comma-separated. Running this command with the force option will make sure the Drupal table's are purged of any reference to the module. operationId: modules_delete security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_modules.html parameters: - $ref: '#/components/parameters/modules' - $ref: '#/components/parameters/force' responses: '200': description: Successful output of the delete module(s) command content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '403': description: Failure - unauthorized content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/role: description: Role object operations parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' get: summary: Get a role defined on the site description: Gets a Drupal User Role defined on the site and all the permissions it has been granted. e.g. './apic --mode portaladmin role:get --server **api** --catalog **catalog** --org **org** administrator' operationId: role_get security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapim_portal_cli_cmd_role.html parameters: - $ref: '#/components/parameters/role' responses: '200': description: Successful output of the role get command content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '403': description: Failure - unauthorized content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal post: summary: Create a new role operationId: role_create security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapim_portal_cli_cmd_role.html parameters: - $ref: '#/components/parameters/machine_name' - $ref: '#/components/parameters/human_readable_name' responses: '200': description: Successful output of the role create command content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '403': description: Failure - unauthorized content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal delete: summary: Delete a role operationId: role_delete security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapim_portal_cli_cmd_role.html parameters: - $ref: '#/components/parameters/role' responses: '200': description: Successful output of the role delete command content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '403': description: Failure - unauthorized content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/role/permission: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' post: summary: Grant specified permission(s) to a role description: Grant specified permission(s) to a role. operationId: role_addPermission security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapim_portal_cli_cmd_role.html parameters: - $ref: '#/components/parameters/role' - $ref: '#/components/parameters/permissions' responses: '200': description: Successful output of the role add permission command content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '403': description: Failure - unauthorized content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal delete: summary: Remove specified permission(s) from a role description: Remove specified permission(s) from a role. operationId: role_removePermission security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapim_portal_cli_cmd_role.html parameters: - $ref: '#/components/parameters/role' - $ref: '#/components/parameters/permissions' responses: '200': description: Successful output of the role remove permission command content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '403': description: Failure - unauthorized content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/role/list: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' get: summary: Display a list of all roles defined on the system. description: Display a list of all roles defined on the system. If a role name is provided as an argument, then all of the permissions of that role will be listed. If a permission name is provided as an option, then all of the roles that have been granted that permission will be listed. operationId: role_list security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapim_portal_cli_cmd_role.html parameters: - $ref: '#/components/parameters/role' - $ref: '#/components/parameters/filter_by_permission' responses: '200': description: Successful output of the role list command content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '403': description: Failure - unauthorized content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/site/cache-rebuild: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' post: summary: Rebuilds the cache of a specific Portal site description: Clears the existing cache and rebuilds a new one for a specific Portal site. operationId: site_cache_rebuild security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_site.html responses: '200': description: Task has completed. content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '404': description: The task was not found. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/themes/list: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' get: summary: Shows a list of available themes description: Show a list of themes for the portal of the provided org and catalog. operationId: themes_list security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_themes.html parameters: - $ref: '#/components/parameters/status' - $ref: '#/components/parameters/package' - $ref: '#/components/parameters/no-core' - $ref: '#/components/parameters/core' - $ref: '#/components/parameters/custom' responses: '200': description: Successful output of the list themes command content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '403': description: Failure - unauthorized content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/themes/enable: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' post: summary: Enable one or more theme description: Enable one or more theme by providing a comma-separated list. operationId: themes_enable security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_themes.html parameters: - $ref: '#/components/parameters/themes' responses: '200': description: Successful output of the enable theme(s) command content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '403': description: Failure - unauthorized content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/themes/disable: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' post: summary: Disable one or more themes description: Disable one or more themes and their dependent modules. The provided list of themes must be comma-separated. operationId: themes_disable security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_themes.html parameters: - $ref: '#/components/parameters/themes' responses: '200': description: Successful output of the disable theme(s) command content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '403': description: Failure - unauthorized content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/themes/delete: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' delete: summary: Deletes one or more themes description: Deletes one or more themes. The provided list of themes must be comma-separated. operationId: themes_delete security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_themes.html parameters: - $ref: '#/components/parameters/themes' responses: '200': description: Successful output of the delete theme(s) command content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '403': description: Failure - unauthorized content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/themes/set-default: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' post: summary: Set a portal's default theme description: Set a portal's default theme. The theme provided must be one that is already enabled. operationId: themes_setDefault security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_themes.html parameters: - $ref: '#/components/parameters/theme' responses: '200': description: Successful output of the set theme command content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '403': description: Failure - unauthorized content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/memcache: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' get: summary: Gets the memcache enabled status on a specific Developer Portal site description: Gets the memcache enabled status on a specific Developer Portal site. operationId: memcache_get security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapim_portal_cli_cmd_memcache.html responses: '200': description: The enabled status of memcache for this Developer Portal. content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '404': description: The task was not found. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/memcache/enable: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' put: summary: Enables memcache on a specific Developer Portal site description: Enables memcache on a specific Developer Portal site. This sets Drupal to use RAM for it's cache. operationId: memcache_enable security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapim_portal_cli_cmd_memcache.html responses: '200': description: Memcache has been successfully enabled. content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '404': description: The task was not found. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/memcache/disable: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' put: summary: Disables memcache on a specific Developer Portal site description: Disables memcache on a specific Developer Portal site. This sets Drupal to use the database as it's cache. operationId: memcache_disable security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapim_portal_cli_cmd_memcache.html responses: '200': description: Memcache has been successfully disabled. content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '404': description: The task was not found. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/twig/debug-enable: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' post: summary: Enables twig debugging on a specific Portal site description: Enables twig debugging on a specific Portal site. Helps locate twig template issues. operationId: twig_debugEnable security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_twig.html responses: '200': description: Task has completed. content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '404': description: The task was not found. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/twig/debug-disable: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' post: summary: Disable twig debugging on a specific Portal site description: Disable twig debugging on a specific Portal site. Helps locate twig template issues. operationId: twig_debugDisable security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_twig.html responses: '200': description: Task has completed. content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '404': description: The task was not found. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/twig/debug-status: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' get: summary: Shows the current state of twig debugging of a specific Portal site description: View the current state of twig debugging of a specific Portal site, if you are unsure of it. operationId: twig_debugStatus security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_twig.html responses: '200': description: Task has completed. content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '404': description: The task was not found. content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/user/role: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' - $ref: '#/components/parameters/role_required' - $ref: '#/components/parameters/mail' - $ref: '#/components/parameters/names' - $ref: '#/components/parameters/uid' post: summary: Add a singular or multiple roles to the specified Drupal User accounts description: Add a singular or multiple roles to the specified Drupal User accounts. You need to provide either the mail, username, or the UID of the Drupal User account. operationId: user_addRole security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_user.html responses: '200': description: Successful output of the Drupal User role add command content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '403': description: Failure - unauthorized content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal delete: summary: Remove a singular or multiple roles from the specified Drupal User accounts description: Remove a singular or multiple roles from the specified Drupal User accounts. You need to provide either the mail, username, or the UID of the Drupal User account. operationId: user_removeRole security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_user.html responses: '200': description: Successful output of the Drupal User role remove command content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '403': description: Failure - unauthorized content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/user/block: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' post: summary: Block a Developer Portal Drupal User description: Block a Developer Portal Drupal User. This will block a Drupal User from being able to login into the Developer Portal. You need to provide the username of the Drupal User. operationId: user_block security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_user.html parameters: - $ref: '#/components/parameters/names' responses: '200': description: Successful output of the Drupal User block command content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '403': description: Failure - unauthorized content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/user/unblock: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' post: summary: Unblock a Developer Portal Drupal User description: Unblock a Developer Portal Drupal User. This will allow a blocked Drupal User to be able to login into the Developer Portal again. You need to provide the username of the Drupal User. operationId: user_unblock security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_user.html parameters: - $ref: '#/components/parameters/names' responses: '200': description: Successful output of the Drupal User unblock command content: application/json: schema: $ref: '#/components/schemas/CliResponse' application/yaml: schema: $ref: '#/components/schemas/CliResponse' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '403': description: Failure - unauthorized content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path /catalogs/{org}/{catalog}/user/information: parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/catalog' get: summary: Gets Developer Portal Drupal User information description: Gets Developer Portal Drupal User information. You can filter on different fields to obtain a list of users matching your criteria. operationId: user_information security: - oauth: - org:manage externalDocs: description: Additional documentation url: https://www.ibm.com/docs/SSMNED_12.1.x_cd/com.ibm.apic.devportal.doc/rapic_portal_cli_cmd_user.html parameters: - $ref: '#/components/parameters/roles' - $ref: '#/components/parameters/mail' - $ref: '#/components/parameters/names' - $ref: '#/components/parameters/uid' - $ref: '#/components/parameters/consumer_org_urls' - $ref: '#/components/parameters/login_before' - $ref: '#/components/parameters/login_after' - $ref: '#/components/parameters/apic_state' - $ref: '#/components/parameters/user_status' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/offset' responses: '200': description: Successful output of the Drupal User information command content: application/json: schema: $ref: '#/components/schemas/UserInformation' application/yaml: schema: $ref: '#/components/schemas/UserInformation' '400': description: Failure content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' '403': description: Failure - unauthorized content: application/json: schema: $ref: '#/components/schemas/Error_2' application/yaml: schema: $ref: '#/components/schemas/Error_2' 5XX: $ref: '#/components/responses/Error' tags: - Portal servers: - url: '' description: Portal Admin base path components: schemas: PortalChatbot: type: object additionalProperties: true properties: type: type: string description: Request/response type. Use 'user-message' to send a message. Use 'user-plan' to execute a plan (toolcalls required). Response types include 'agent-plan' and 'agent-response'. message: type: string description: The user's message to send to the AI agent (used with type 'user-message') maxLength: 4000 agent_message: type: string description: The AI agent's response message items: type: object plan_title: type: - string - 'null' description: Title of the plan from the AI agent plan_description: type: - string - 'null' description: Description of the plan from the AI agent Error: type: object additionalProperties: false properties: status: type: integer minimum: 400 maximum: 599 message: type: array items: type: string errors: type: array items: type: string CliResponse: x-bhendi-schema: custom type: object additionalProperties: false properties: status: type: integer minimum: 0 maximum: 999 message: type: object additionalProperties: false properties: stdout: type: string stderr: type: string errors: type: array items: type: string Error_2: x-bhendi-schema: custom type: object additionalProperties: false properties: status: type: integer minimum: 0 maximum: 2147483647 message: type: array items: type: string errors: type: array items: type: string User: type: object description: Developer Portal Drupal User additionalProperties: true properties: uid: type: string description: The uid of the Developer Portal Drupal User. example: '1' name: type: string description: The username of the Developer Portal Drupal User. example: portaluser1 mail: type: string description: The email address of the Developer Portal Drupal User. example: portaluser1@ibm.com roles: type: array description: The roles of the Developer Portal Drupal User. items: type: string example: authenticated example: - authenticated - content_author status: type: string description: The status of the Developer Portal Drupal User. example: active apic_state: type: string description: The APIC state of the Developer Portal Drupal User. example: enabled last_login: type: string description: The last login time of the Developer Portal Drupal User. example: 11/27/2023 11:45:07 user_registry: type: string description: The user registry of the Developer Portal Drupal User. example: /consumer-api/user-registries/642d900f-3efb-4778-923b-80da799b27b7 (API Connect Catalog 1 Catalog User Registry) consumer_orgs: type: array description: The consumer organizations the Developer Portal Drupal User is apart of. items: type: string example: authenticated PageType: name: PageType type: string default: index enum: - index - '404' - 40x - 50x ApicState: name: ApicState type: string default: enabled enum: - enabled - pending - pending_approval InputFormat: name: InputFormat type: string default: auto enum: - auto - string - integer - float - boolean - json - yaml UserStatus: name: UserStatus type: string default: enabled enum: - active - blocked UserList: type: array description: Array of Developer Portal Drupal Users. items: $ref: '#/components/schemas/User' UserInformation: x-bhendi-schema: custom type: object additionalProperties: false properties: total: type: integer offset: type: integer limit: type: integer users: description: Array of Developer Portal Drupal Users. $ref: '#/components/schemas/UserList' parameters: consumer_org_url: name: consumer_org_url in: query description: Consumer Org Url required: false schema: type: string chat-session: name: chat-session in: path description: Chat session ID required: true schema: type: string entity_ids: name: entity_ids in: query description: A comma-separated list of Content IDs. required: false schema: type: string example: 4,76,23 custom: name: custom in: query description: Filter to only custom modules or themes required: false schema: type: boolean names: name: names in: query description: A comma-separated list of names of Drupal Users to perform the action on. required: false schema: type: string consumer-org: name: consumer-org in: query description: The ID of a specific Consumer Organization. required: true schema: type: string modules: name: modules in: query description: A list of modules separated by a comma. required: true schema: type: string limit: name: limit in: query description: Limit the amount of results returned. required: false schema: type: integer login_before: name: login-before in: query description: A date to filter Drupal Users who last logged in before the provided date. Date needs to be given in format of MM-DD-YYY or MM-DD-YY HH:MM:SS required: false schema: type: string api: name: api in: query description: The ID or name:version of a specific API. e.g. 'id-of-api-called-example-3' or 'example:3.0.0'. required: true schema: type: string user_status: name: status in: query description: Filter by Drupal User status. Choices are 'active' or 'blocked'. required: false schema: $ref: '#/components/schemas/UserStatus' themes: name: themes in: query description: A list of themes separated by a comma. required: true schema: type: string portal_service_endpoint: name: portal_service_endpoint in: query description: The URL endpoint of the Portal Service required: true schema: type: string format: uri role_required: name: role in: query description: The name of the Drupal User Role. required: true schema: type: string config_name: name: config_name in: query description: The config object name, for example "system.site". required: true schema: type: string org: name: org in: path description: Name or ID of the organization the catalog belongs to. required: true schema: type: string force: name: force in: query description: Provides the force flag to the subsequent command. The force action is dependent on the command. Please read the command description. required: false schema: type: boolean task_id: name: task_id in: path description: ID of the task created on the queue. required: true schema: type: string wait_cache: name: wait in: query description: Wait on the cache to be rebuilt as part of the task, otherwise it will be rebuilt in the background after the task has finished. required: false schema: type: boolean ip_security_enabled: name: enabled in: query description: Set to true or false to enable or disable IP security. required: true schema: type: string core: name: core in: query description: Filter out extensions that are not in Drupal Core. required: false schema: type: boolean roles: name: role in: query description: A comma-separated list of Drupal User Roles. required: false schema: type: string config_key_optional: name: config_key in: query description: A config key, for example "page.front". required: false schema: type: string theme: name: theme in: query description: A name of a single theme. required: true schema: type: string icon_description: name: icon_description in: query description: A description of the icon to be displayed to users. Used as alt text for the image. required: true schema: type: string bundle: name: bundle in: query description: The Bundle type for a given Entity type. E.g. "page" for the "node" Entity type. required: false schema: type: string attachment_name: name: attachment_name in: query description: The name given to the attachment once it has been uploaded e.g. my-file.txt required: true schema: type: string entity_type_query: name: entity_type in: query description: Type of content you want to perform this operation on. To find out content types see the content list-types route. required: true schema: type: string default: node example: node state_value: name: state_value in: query description: The value to assign to the state key. required: true schema: type: string human_readable_name: name: human_readable_name in: query description: A descriptive name for the Drupal role. required: true schema: type: string offset: name: offset in: query description: Offset the results return to aid in Pagination. required: false schema: type: integer status: name: status in: query description: Filter by extension status. Choices _ enabled, disabled and/or 'not installed'. You can use multiple comma-separated values. required: false schema: type: string export_entity_id: name: export_entity_id in: path description: ID of the export entity required: true schema: type: string example: '4' permissions: name: permissions in: query description: The list of permission to grant, delimited by commas. required: true schema: type: string application: name: application in: query description: The ID of a specific Application. required: true schema: type: string consumer_org_urls: name: consumer-org in: query description: A comma-separated list of Consumer Org URLs to filter the return by. required: false schema: type: string langcodes: name: langcodes in: query description: A comma-separated list of language codes e.g. "es,zh-hans" required: false schema: type: string entity_type: name: entity_type in: path description: Type of content you want to perform this operation on. To find out content types see the content list-types route. required: true schema: type: string default: node example: node role: name: role in: query description: The name of the Drupal User Role. required: false schema: type: string login_after: name: login-after in: query description: A date to filter Drupal Users who last logged in after the provided date. Date needs to be given in format of MM-DD-YYY or MM-DD-YY HH:MM:SS required: false schema: type: string attachment_description: name: attachment_description in: query description: A description of the attachment to be displayed to users. required: false schema: type: string catalog: name: catalog in: path description: Name or ID of the Catalog that the site belongs to. required: true schema: type: string input_format: name: input_format in: query description: 'The input format of the value for the state key. Values: string, integer, float, boolean, json, yaml. [default: auto]' required: false schema: $ref: '#/components/schemas/InputFormat' package: name: package in: query description: Filter by project packages. You can use multiple comma-separated values. required: false schema: type: string ips: name: ips in: query description: A comma-separated list of IPs. required: true schema: type: string no-core: name: no-core in: query description: Filter out extensions that are provided by Drupal Core. required: false schema: type: boolean export_entity_name: name: export_entity_name in: query description: name of the export entity required: false schema: type: string example: My Export Entity memory_value: name: memory_value in: query description: The memory value in megabytes (mb) required: true schema: type: string portal_service_name: name: portal_service_name in: query description: The name of the Portal Service required: true schema: type: string mail: name: mail in: query description: A comma-separated list of Drupal User Email addresses to perform the action on. required: false schema: type: string execute_reset: name: execute_reset in: query description: Set to true to trigger the Developer Portal reset required: false schema: type: string config_key: name: config_key in: query description: A config key, for example "page.front". required: true schema: type: string apic_state: name: apic-state in: query description: A comma-separated list of APIC states to filter Drupal Users by. required: false schema: $ref: '#/components/schemas/ApicState' page_type: name: page_type in: query description: 'The page type you want to run this command against. Values: index, 404, 40x, 50x' required: true schema: $ref: '#/components/schemas/PageType' uid: name: uid in: query description: A comma-separated list of UIDs of Drupal Users to perform the action on. required: false schema: type: string machine_name: name: machine_name in: query description: The symbolic machine name for the role. required: true schema: type: string state_key: name: state_key in: query description: The state key, for example "system.cron_last". required: true schema: type: string tag_name: name: tag_name in: query description: The tag name e.g. top_level_element/next_level_element required: true schema: type: string product: name: product in: query description: The id or name:version of a specific application. e.g. 'id-of-product-called-example-3' or 'example:3.0.0'. required: true schema: type: string config_value: name: config_value in: query description: The value to assign to the config key. required: true schema: type: string responses: Error: description: Unexpected error content: application/json: schema: $ref: '#/components/schemas/Error' application/yaml: schema: $ref: '#/components/schemas/Error' securitySchemes: oauth: type: oauth2 flows: password: tokenUrl: /token refreshUrl: /token scopes: app:manage: Create a Application object, Clear the Application objects, Update the Application object by name or id, Delete the Application object by name or id, Create a Application Credential object, Clear the Application Credential objects, Update the Application Credential object by name or id, Delete the Application Credential object by name or id, Create a Subscription object, Clear the Subscription objects, Update the Subscription object by name or id, Delete the Subscription object by name or id app:view: List the Application objects, Get the Application object by name or id, List the Application Credential objects, Get the Application Credential object by name or id, List the Subscription objects, Get the Subscription object by name or id my:manage: Update the Me object, Delete the Me object my:view: Get the Me object, List the My Permission objects, List the My Organization objects org:manage: Create a My Organization object, Update the Organization object by name or id, Delete the Organization object by name or id, Create a Member Invitation object, Clear the Member Invitation objects, Delete the Member Invitation object by name or id, Clear the Member objects, Update the Member object by name or id, Delete the Member object by name or id, Create a Payment Method object, Update the Payment Method object by name or id, Delete the Payment Method object by name or id org:view: List all Permission objects in all collections, Get the Organization object by name or id, Get the Group object by name or id, List the Member Invitation objects, Get the Member Invitation object by name or id, List the User Registry objects, Get the User Registry object by name or id, Get the User object by name or id, List the Associate objects, Get the Associate object by name or id, List the Member objects, Get the Member object by name or id, List the Role objects, Get the Role object by name or id, Get the Billing object by name or id, List the Billing objects, List the Payment Method objects, Get the Payment Method object by name or id, List the Payment Method Type objects, Get the Payment Method Type object by name or id authorizationCode: authorizationUrl: /oauth2/authorize tokenUrl: /token refreshUrl: /token scopes: app:manage: Create a Application object, Clear the Application objects, Update the Application object by name or id, Delete the Application object by name or id, Create a Application Credential object, Clear the Application Credential objects, Update the Application Credential object by name or id, Delete the Application Credential object by name or id, Create a Subscription object, Clear the Subscription objects, Update the Subscription object by name or id, Delete the Subscription object by name or id app:view: List the Application objects, Get the Application object by name or id, List the Application Credential objects, Get the Application Credential object by name or id, List the Subscription objects, Get the Subscription object by name or id my:manage: Update the Me object, Delete the Me object my:view: Get the Me object, List the My Permission objects, List the My Organization objects org:manage: Create a My Organization object, Update the Organization object by name or id, Delete the Organization object by name or id, Create a Member Invitation object, Clear the Member Invitation objects, Delete the Member Invitation object by name or id, Clear the Member objects, Update the Member object by name or id, Delete the Member object by name or id, Create a Payment Method object, Update the Payment Method object by name or id, Delete the Payment Method object by name or id org:view: List all Permission objects in all collections, Get the Organization object by name or id, Get the Group object by name or id, List the Member Invitation objects, Get the Member Invitation object by name or id, List the User Registry objects, Get the User Registry object by name or id, Get the User object by name or id, List the Associate objects, Get the Associate object by name or id, List the Member objects, Get the Member object by name or id, List the Role objects, Get the Role object by name or id, Get the Billing object by name or id, List the Billing objects, List the Payment Method objects, Get the Payment Method object by name or id, List the Payment Method Type objects, Get the Payment Method Type object by name or id x-refined-from: - ibm-api-connect-consumer-api-openapi.yml - ibm-api-connect-portal-admin-api-openapi.yml x-ibm-configuration: testable: false