> ## Documentation Index
> Fetch the complete documentation index at: https://developers.aptranet.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Create API Path

> Project-scoped operation. Requires the api_security add-on. Successful JSON and status-only responses vary by operation. The service does not declare a stable response schema for this operation; do not assume a collection envelope or undocumented fields.



## OpenAPI

````yaml /openapi-shield.json post /shield/domains/{domain_id}/api-paths
openapi: 3.1.0
info:
  title: Aptranet Cloud Shield API
  version: 1.0.0
  description: >-
    Public project-scoped API. Use the access key and secret together.
    Browser-only organization administration is documented separately. Request
    schemas and query parameters follow the service operation allowlist. Plan
    entitlements apply in addition to API permissions. Some analytics and action
    responses have operation-specific JSON shapes; where the implementation
    provides no stable response contract, the reference deliberately does not
    invent one.
servers:
  - url: https://api.aptranet.com
security:
  - bearerAuth: []
    apiSecret: []
paths:
  /shield/domains/{domain_id}/api-paths:
    post:
      tags:
        - Cloud Shield API Discovery
      summary: Create API Path
      description: >-
        Project-scoped operation. Requires the api_security add-on. Successful
        JSON and status-only responses vary by operation. The service does not
        declare a stable response schema for this operation; do not assume a
        collection envelope or undocumented fields.
      operationId: POST_shield_domains_domain_id_api_paths
      parameters:
        - name: domain_id
          in: path
          required: true
          schema:
            type: integer
            title: Domain Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - path
                - method
                - http_scheme
              title: CreateApiPath
              properties:
                path:
                  type: string
                  maxLength: 1024
                  example: /api/v1/paths/{path_id}
                  title: Path
                method:
                  type: string
                  enum:
                    - GET
                    - POST
                    - PUT
                    - PATCH
                    - DELETE
                    - TRACE
                    - HEAD
                    - OPTIONS
                  title: ApiPathMethod
                http_scheme:
                  type: string
                  enum:
                    - HTTP
                    - HTTPS
                  title: ApiPathHttpScheme
                api_version:
                  type: string
                  maxLength: 32
                  example: v1
                  title: Api Version
                tags:
                  type: array
                  maxItems: 5
                  title: Tags
                  items:
                    type: string
                    maxLength: 50
                api_groups:
                  type: array
                  title: Api Groups
                  items:
                    type: string
      responses:
        2XX:
          description: Successful response.
        default:
          description: >-
            Request rejected or service unavailable. See the error code and
            description; refresh before retrying a mutation whose result is
            uncertain.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          type: string
        error_description:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Project API access key.
    apiSecret:
      type: apiKey
      in: header
      name: Aptranet-Secret
      description: Current secret for the access key.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.