> ## Documentation Index > Fetch the complete documentation index at: https://gcore.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Scan an API description file > Scan an API description file hosted online. The file must be in YAML or JSON format and adhere to the OpenAPI specification. The location of the API description file should be specified in the API discovery settings. ## OpenAPI ````yaml /api-reference/services_documented/waap_api.yaml post /waap/v1/domains/{domain_id}/api-discovery/scan openapi: 3.1.0 info: title: Gcore OpenAPI – WAAP API description: >- This OpenAPI is an aggregated OpenAPI specification that unifies all Gcore products into a single file. It covers Cloud, CDN, DNS, WAAP, DDoS Protection, Object Storage, Streaming, and FastEdge services. version: '2026-05-15T06:37:28.230198+00:00' servers: - url: https://api.gcore.com security: - APIKey: [] tags: - name: WAAP Service x-displayName: WAAP Service - name: Domains x-displayName: Domains - name: Policies x-displayName: Policies - name: Analytics x-displayName: Analytics - name: Custom Page Sets x-displayName: Custom Page Sets - name: Custom Rules x-displayName: Custom Rules - name: Filter Templates x-displayName: Filter Templates - name: Firewall Rules x-displayName: Firewall Rules - name: Advanced Rules x-displayName: Advanced Rules - name: Tags x-displayName: Tags - name: Network Organizations x-displayName: Network Organizations - name: API Discovery x-displayName: API Discovery - name: IP Spotlight x-displayName: IP Spotlight - name: Security Insights x-displayName: Security Insights - name: IP Reputation x-displayName: IP Reputation paths: /waap/v1/domains/{domain_id}/api-discovery/scan: post: tags: - API Discovery summary: Scan an API description file description: >- Scan an API description file hosted online. The file must be in YAML or JSON format and adhere to the OpenAPI specification. The location of the API description file should be specified in the API discovery settings. operationId: scan_spec_file_v1_domains__domain_id__api_discovery_scan_post parameters: - name: domain_id in: path required: true schema: type: integer exclusiveMinimum: 0 description: The domain ID title: Domain Id description: The domain ID responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/TaskResultId' '400': content: application/problem+json: schema: $ref: '#/components/schemas/APIError' example: type: http-bad-request title: Bad Request status: 400 detail: 'Invalid domain name: ''''''''' description: Bad Request '401': description: Feature check fail content: application/problem+json: example: title: Feature check fail type: feature-check status: 401 detail: >- This feature is not available under your current plan. Please upgrade your plan to access this feature. '403': description: Unauthenticated content: application/problem+json: example: detail: Permission denied '404': description: Resource not found content: application/problem+json: example: title: Resource not found type: quota-check-no-resource status: 404 detail: >- The quota resource requested does not exist. Cannot enable WAAP for this domain. Please reach out to our support team. '422': content: application/problem+json: schema: $ref: '#/components/schemas/APICompositeError' example: type: request-validation-failed title: Request validation error. status: 422 detail: One or more fields have validation errors. errors: - loc: - body - name detail: Input should be a valid string - loc: - body - date detail: Field required - loc: - query - limit detail: Field required description: Unprocessable Entity '500': content: application/problem+json: schema: $ref: '#/components/schemas/APIError' example: type: internal-server-error title: Internal server error. status: 500 detail: >- An unexpected condition was encountered which prevented the server from fulfilling the request. description: Internal Server Error x-codeSamples: - lang: Python source: |- import os from gcore import Gcore client = Gcore( api_key=os.environ.get("GCORE_API_KEY"), # This is the default and can be omitted ) waap_task_id = client.waap.domains.api_discovery.openapi.scan( 1, ) print(waap_task_id.id) - lang: Go source: "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/G-Core/gcore-go\"\n\t\"github.com/G-Core/gcore-go/option\"\n)\n\nfunc main() {\n\tclient := gcore.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\twaapTaskID, err := client.Waap.Domains.APIDiscovery.OpenAPI.Scan(context.TODO(), 1)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", waapTaskID.ID)\n}\n" components: schemas: TaskResultId: properties: id: type: string format: uuid title: Id description: The task ID type: object required: - id title: TaskResultId description: Response model for the task result ID APIError: properties: type: type: string title: Type description: A URI identifier that categorizes the type of error. title: type: string title: Title description: A brief, human-readable title for the error. status: type: integer title: Status description: The HTTP status code applicable to this error. detail: anyOf: - type: string - type: 'null' title: Detail description: A detailed human-readable explanation of the error. type: object required: - type - title - status - detail title: APIError APICompositeError: properties: type: type: string title: Type description: A URI identifier that categorizes the type of error. title: type: string title: Title description: A brief, human-readable title for the error. status: type: integer title: Status description: The HTTP status code applicable to this error. detail: anyOf: - type: string - type: 'null' title: Detail description: A detailed human-readable explanation of the error. errors: items: $ref: '#/components/schemas/APIFieldError' type: array title: Errors description: A list of detailed errors for individual fields. type: object required: - type - title - status - detail - errors title: APICompositeError APIFieldError: properties: loc: anyOf: - items: anyOf: - type: integer - type: string type: array - {} title: Loc description: The location of the field or a character number causing the error. detail: type: string title: Detail description: A human-readable message describing the error. type: object required: - loc - detail title: APIFieldError securitySchemes: APIKey: description: >- API key for authentication. Make sure to include the word `apikey`, followed by a single space and then your token. Example: `apikey 1234$abcdef` type: apiKey in: header name: Authorization ````