> ## 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.

# Get Cloud Shield readiness and entitlements



## OpenAPI

````yaml /openapi-shield.json get /shield/service
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/service:
    get:
      tags:
        - Cloud Shield service
      summary: Get Cloud Shield readiness and entitlements
      operationId: GET_shield_service
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
                properties:
                  active:
                    type: boolean
                  ready:
                    type: boolean
                  development:
                    type: boolean
                  plan_code:
                    type: string
                  limits:
                    type: object
                    properties:
                      domains:
                        type: integer
                      custom_rules:
                        type: integer
                      firewall_rules:
                        type: integer
                  addons:
                    type: object
                    additionalProperties:
                      type: boolean
                required:
                  - active
                  - ready
                  - plan_code
                  - limits
                  - addons
        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.