---
title: "Delete Portal"
url: "https://nov18-dev.movespot.fyi/apis/internal-api-builder-v1-1/versions/37dd8750-3a87-4f5b-aa5c-d7d8aa14eea8/operations/delete-portal"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/internal-api-builder-v1-1/versions/37dd8750-3a87-4f5b-aa5c-d7d8aa14eea8.md

# Delete Portal

`DELETE` `/internal/portals/{portalId}`

Operation ID: `delete-portal`

Deletes portal specified in path

## Path parameters

- `portalId` (string, uuid, required) - ID of the portal.

## Query parameters

- `force` (string, optional) - If true, delete also related publications entities

## Responses

- `204` - No Content.
- `404` - Not Found

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Internal API-Builder v1
  version: 1.0.13
servers:
  - url: builder.apibuilder.svc.cluster.local:3000/v1
    description: Konnect cluster
paths:
  /internal/portals/{portalId}:
    parameters:
      - $ref: "#/components/parameters/PortalId"
    delete:
      operationId: delete-portal
      summary: Delete Portal
      description: Deletes portal specified in path
      parameters:
        - name: force
          in: query
          description: If true, delete also related publications entities
          schema:
            type: string
            default: "false"
            enum:
              - "true"
              - "false"
      responses:
        "204":
          description: No Content.
        "404":
          $ref: "#/components/responses/NotFound"
      tags:
        - portal
components:
  parameters:
    PortalId:
      schema:
        type: string
        format: uuid
      name: portalId
      in: path
      required: true
      description: ID of the portal.
  responses:
    NotFound:
      description: Not Found
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/NotFoundError"
          examples:
            NotFoundExample:
              $ref: "#/components/examples/NotFoundExample"
  schemas:
    NotFoundError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 404
            title:
              example: Not Found
            type:
              example: https://httpstatuses.com/404
            instance:
              example: kong:trace:1234567890
            detail:
              example: Not found
    BaseError:
      description: standard error
      type: object
      properties:
        status:
          description: >
            The HTTP status code of the error. Useful when passing the response

            body to child properties in a frontend UI. Must be returned as an
            integer.
          type: integer
          readOnly: true
        title:
          description: |
            A short, human-readable summary of the problem. It should not
            change between occurences of a problem, except for localization.
            Should be provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
        type:
          description: The error type.
          type: string
          readOnly: true
        instance:
          description: |
            Used to return the correlation ID back to the user, in the format
            kong:trace:<correlation_id>. This helps us find the relevant logs
            when a customer reports an issue.
          type: string
          readOnly: true
        detail:
          description: >
            A human readable explanation specific to this occurence of the
            problem.

            This field may contain request/entity data to help the user
            understand

            what went wrong. Enclose variable values in square brackets. Should
            be

            provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
      required:
        - status
        - title
        - instance
        - detail
      title: Error
  examples:
    NotFoundExample:
      value:
        status: 404
        title: Not Found
        instance: kong:trace:6816496025408232265
        detail: Not Found
```
