---
title: "Fetch details for multiple APIs (internal)"
url: "https://nov18-dev.movespot.fyi/apis/internal-api-builder-v1-1/versions/37dd8750-3a87-4f5b-aa5c-d7d8aa14eea8/operations/post-api-details-by-id"
---

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

# Fetch details for multiple APIs (internal)

`POST` `/internal/apis/details-by-id`

Operation ID: `post-api-details-by-id`

Accepts an array of API ids in body Returns a list of APIs with their details

## Request body (required)

Content types: `application/json`

## Responses

- `200` - A response containing a single DCR provider object.
- `400` - Bad Request
- `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/apis/details-by-id:
    post:
      operationId: post-api-details-by-id
      summary: Fetch details for multiple APIs (internal)
      description: |
        Accepts an array of API ids in body
        Returns a list of APIs with their details
      requestBody:
        $ref: "#/components/requestBodies/PostApiDetailsByIds"
      responses:
        "200":
          $ref: "#/components/responses/PostApiDetailsByIdsResponse"
        "400":
          $ref: "#/components/responses/BadRequest"
        "404":
          $ref: "#/components/responses/NotFound"
      tags:
        - apis
components:
  requestBodies:
    PostApiDetailsByIds:
      required: true
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ApiIds"
          examples:
            ApiDetailsByIds:
              $ref: "#/components/examples/ApiDetailsByIdsRequest"
  responses:
    PostApiDetailsByIdsResponse:
      description: A response containing a single DCR provider object.
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ApisDetailsById"
          examples:
            ApiDetailsByIdsResponse:
              $ref: "#/components/examples/ApiDetailsByIdsResponse"
    BadRequest:
      description: Bad Request
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/BadRequestError"
    NotFound:
      description: Not Found
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/NotFoundError"
          examples:
            NotFoundExample:
              $ref: "#/components/examples/NotFoundExample"
  schemas:
    ApiIds:
      type: object
      properties:
        api_ids:
          type: array
          items:
            type: string
            format: uuid
      required:
        - api_ids
    ApisDetailsById:
      type: object
      properties:
        apis:
          type: array
          items:
            $ref: "#/components/schemas/ApiDetails"
      required:
        - apis
    BadRequestError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          required:
            - invalid_parameters
          properties:
            invalid_parameters:
              $ref: "#/components/schemas/InvalidParameters"
    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
    ApiDetails:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        version:
          type: string
          nullable: true
        slug:
          type: string
      required:
        - id
        - name
        - version
        - slug
    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
    InvalidParameters:
      description: invalid parameters
      type: array
      items:
        oneOf:
          - $ref: "#/components/schemas/InvalidParameterStandard"
          - $ref: "#/components/schemas/InvalidParameterMinimumLength"
          - $ref: "#/components/schemas/InvalidParameterMaximumLength"
          - $ref: "#/components/schemas/InvalidParameterChoiceItem"
          - $ref: "#/components/schemas/InvalidParameterDependentItem"
      minItems: 1
      nullable: false
      uniqueItems: true
    InvalidParameterStandard:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          $ref: "#/components/schemas/InvalidRules"
        source:
          type: string
          example: body
        reason:
          type: string
          example: is a required field
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
    InvalidParameterMinimumLength:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - min_length
            - min_digits
            - min_lowercase
            - min_uppercase
            - min_symbols
            - min_items
            - min
          nullable: false
          readOnly: true
        minimum:
          type: integer
          example: 8
        source:
          type: string
          example: body
        reason:
          type: string
          example: must have at least 8 characters
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - minimum
    InvalidParameterMaximumLength:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - max_length
            - max_items
            - max
          nullable: false
          readOnly: true
        maximum:
          type: integer
          example: 8
        source:
          type: string
          example: body
        reason:
          type: string
          example: must not have more than 8 characters
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - maximum
    InvalidParameterChoiceItem:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - enum
          nullable: false
          readOnly: true
        reason:
          type: string
          example: is a required field
          readOnly: true
        choices:
          type: array
          items: {}
          minItems: 1
          nullable: false
          readOnly: true
          uniqueItems: true
        source:
          type: string
          example: body
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - choices
    InvalidParameterDependentItem:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - dependent_fields
          nullable: true
          readOnly: true
        reason:
          type: string
          example: is a required field
          readOnly: true
        dependents:
          type: array
          items: {}
          nullable: true
          readOnly: true
          uniqueItems: true
        source:
          type: string
          example: body
      additionalProperties: false
      required:
        - field
        - rule
        - reason
        - dependents
    InvalidRules:
      description: invalid parameters rules
      type: string
      enum:
        - required
        - is_array
        - is_base64
        - is_boolean
        - is_date_time
        - is_integer
        - is_null
        - is_number
        - is_object
        - is_string
        - is_uuid
        - is_fqdn
        - is_arn
        - unknown_property
        - missing_reference
        - is_label
        - matches_regex
        - invalid
        - is_supported_network_availability_zone_list
        - is_supported_network_cidr_block
        - is_supported_provider_region
        - type
      nullable: true
      readOnly: true
  examples:
    ApiDetailsByIdsRequest:
      summary: Application auth strategy request example
      value:
        api_ids:
          - 93f8380e-7798-4566-99e3-2edf2b57d289
          - 7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
    ApiDetailsByIdsResponse:
      summary: Application auth strategy request example
      value:
        apis:
          - id: 93f8380e-7798-4566-99e3-2edf2b57d289
            name: api1
            slug: api1-slug
            version: 1.0.0
          - id: 7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
            name: api2
            slug: api2-slug
            version: 2.0.0
    NotFoundExample:
      value:
        status: 404
        title: Not Found
        instance: kong:trace:6816496025408232265
        detail: Not Found
```
