swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector ValidateProbe API
schemes:
- https
tags:
- name: ValidateProbe
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.Cdn/validateProbe:
    post:
      tags:
      - ValidateProbe
      description: Check if the probe path is a valid path and the file can be accessed. Probe path is the path to a file hosted on the origin server to help accelerate the delivery of dynamic content via the CDN endpoint. This path is relative to the origin path specified in the endpoint configuration.
      operationId: microsoftAzureValidateprobe
      x-ms-examples:
        ValidateProbe:
          $ref: ./examples/ValidateProbe.json
      parameters:
      - name: validateProbeInput
        in: body
        description: Input to check.
        required: true
        schema:
          $ref: '#/definitions/ValidateProbeInput'
      - $ref: '#/parameters/subscriptionIdParameter'
      - $ref: '#/parameters/apiVersionParameter'
      responses:
        '200':
          description: OK. The request has succeeded.
          schema:
            $ref: '#/definitions/ValidateProbeOutput'
        default:
          description: CDN error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Cdn Validateprobe
definitions:
  ErrorResponse:
    title: Error response
    description: Error response indicates Azure Front Door Standard or Azure Front Door Premium or CDN service is not able to process the incoming request. The reason is provided in the error message.
    type: object
    properties:
      error:
        $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorDetail
  ValidateProbeInput:
    description: Input of the validate probe API.
    properties:
      probeURL:
        description: The probe URL to validate.
        type: string
    required:
    - probeURL
    type: object
  ValidateProbeOutput:
    description: Output of the validate probe API.
    properties:
      isValid:
        description: Indicates whether the probe URL is accepted or not.
        readOnly: true
        type: boolean
      errorCode:
        description: Specifies the error code when the probe url is not accepted.
        readOnly: true
        type: string
      message:
        description: The detailed error message describing why the probe URL is not accepted.
        readOnly: true
        type: string
    type: object
parameters:
  subscriptionIdParameter:
    name: subscriptionId
    in: path
    description: Azure Subscription ID.
    required: true
    type: string
  apiVersionParameter:
    name: api-version
    in: query
    required: true
    type: string
    description: Version of the API to be used with the client request. Current version is 2023-05-01.
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'