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

# Retry custom-URL health check

> Run an on-demand health check for a single custom-URL catalog entry and return the refreshed entry with its updated ``status`` and ``last_checked_at``. The check is synchronous (the caller gets the fresh result inline). Returns ``404`` if the entry doesn't exist, belongs to another org, or the caller lacks CONTRIBUTE permission.



## OpenAPI

````yaml /openapi/openapi-resolver.json post /resolver/api/v1/organizations/{organization_id}/custom-urls/{custom_url_id}/retry
openapi: 3.1.0
info:
  title: Resolver API
  version: 1.0.0
  description: >
    GS1 Digital Link resolution with content negotiation and linkset support.


    ## Authentication


    All endpoints require an API key passed via the `X-API-Key` HTTP header,
    unless otherwise noted.


    ```

    X-API-Key: csb_<body>_<checksum>

    ```


    Generate API keys in **Settings > API Keys** in your dashboard, or via the
    Account API.

    Session-based (cookie) authentication is also accepted for browser-based
    access.


    ## Rate Limits


    | Tier        | Requests / minute | Requests / day |

    |-------------|-------------------|----------------|

    | Default     | 300               | 10,000         |

    | Custom      | Contact us        | Contact us     |


    Rate-limit headers are included on every response so callers can
    self-throttle without

    hitting our 429s ("informed governor"):


    - `RateLimit-Policy` — every active window, e.g. `300;w=60, 10000;w=86400`

    - `RateLimit-Limit` — quota for the **most-restrictive** currently-active
    window

    - `RateLimit-Remaining` — requests left in that window

    - `RateLimit-Reset` — seconds until that window resets (relative; clock-skew
    safe)


    Legacy `X-RateLimit-*` aliases are also emitted for back-compat.
    `X-RateLimit-Reset`

    keeps the absolute Unix-timestamp shape to avoid breaking existing
    consumers.


    When rate-limited, you receive `429 Too Many Requests` with a
    `retry_after_seconds` field

    in the error envelope and a `Retry-After` header.


    ## Pagination


    List endpoints return paginated results in this envelope:


    ```json

    {
      "data": [...],
      "pagination": {
        "page": 1,
        "page_size": 25,
        "total_count": 342,
        "total_pages": 14,
        "has_next": true,
        "has_previous": false
      }
    }

    ```


    Use `?page=2&page_size=50` query parameters. Maximum page size is 100.


    ## Error Responses


    All errors conform to [RFC 9457 Problem
    Details](https://www.rfc-editor.org/rfc/rfc9457)

    with `Content-Type: application/problem+json`:


    ```json

    {
      "type": "https://closient.com/docs/errors/not_found",
      "title": "Not Found",
      "status": 404,
      "detail": "The requested resource was not found.",
      "error_code": "not_found",
      "retryable": false,
      "timestamp": "2026-03-31T12:00:00+00:00"
    }

    ```


    Common error codes: `unauthorized` (401), `forbidden` (403), `not_found`
    (404),

    `validation_error` (422), `rate_limited` (429), `internal_error` (500).
  termsOfService: https://www.closient.com/terms/
servers:
  - url: https://www.closient.com
security: []
tags:
  - name: Resolver
    description: GS1 Digital Link resolution with content negotiation and linkset support.
  - name: Custom URLs
    description: >-
      Reusable custom-URL catalog (C-3339) — create, list, edit, and delete the
      custom redirect destinations that resolution rules point at.
  - name: Verification
    description: >-
      Serial verification (`gs1:verificationService`) — tiered, rate-limited
      responses for serialized GTIN scans. Experimental v1; see the
      verification-service guide.
  - name: Resolver Custom Hostnames
    description: >-
      BYO domain (C-4058) — register a customer-owned hostname, publish the
      CNAME records, verify ownership, and serve an org's Digital Link QRs from
      its own DNS.
externalDocs:
  description: Closient Documentation
  url: https://docs.closient.com
paths:
  /resolver/api/v1/organizations/{organization_id}/custom-urls/{custom_url_id}/retry:
    post:
      tags:
        - Custom URLs
      summary: Retry custom-URL health check
      description: >-
        Run an on-demand health check for a single custom-URL catalog entry and
        return the refreshed entry with its updated ``status`` and
        ``last_checked_at``. The check is synchronous (the caller gets the fresh
        result inline). Returns ``404`` if the entry doesn't exist, belongs to
        another org, or the caller lacks CONTRIBUTE permission.
      operationId: apps_resolver_api_custom_urls_retry_custom_url
      parameters:
        - in: path
          name: organization_id
          schema:
            description: UUID of the owning organization. Caller must have CONTRIBUTE.
            format: shortuuid
            maxLength: 22
            minLength: 22
            pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
            title: Organization Id
            type: string
          required: true
          description: UUID of the owning organization. Caller must have CONTRIBUTE.
        - in: path
          name: custom_url_id
          schema:
            description: URL-safe short_id of the custom-URL entry to re-check.
            format: shortuuid
            maxLength: 22
            minLength: 22
            pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
            title: Custom Url Id
            type: string
          required: true
          description: URL-safe short_id of the custom-URL entry to re-check.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomURLOut'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
      security:
        - APIKeyHeaderAuth: []
        - OAuthTokenAuth: []
        - SessionAuth: []
components:
  schemas:
    CustomURLOut:
      description: A custom-URL catalog entry as read from the API.
      examples:
        - created: '2026-06-01T09:00:00Z'
          id: a1b2c3d4e5f6
          last_checked_at: '2026-06-19T14:30:00Z'
          modified: '2026-06-19T14:30:00Z'
          organization_id: b2c3d4e5-f678-9012-abcd-ef2345678901
          status: HEALTHY
          url: https://acmesnacks.com/holiday-promo
      properties:
        id:
          description: >-
            URL-safe 22-character shortuuid encoding of the row's UUID primary
            key. Stable across the row's lifetime; suitable for sharing in URLs,
            log lines, and external SDK clients. Accepted on input as either the
            shortuuid form or the canonical UUID form
            (``xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx``).
          format: shortuuid
          maxLength: 22
          minLength: 22
          pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
          title: Id
          type: string
        url:
          description: >-
            Destination URL a matching scan redirects to. Must be a valid
            absolute http(s) URL (max 2048 chars).
          title: Url
          type: string
        status:
          $ref: '#/components/schemas/CustomURLStatusEnum'
          description: >-
            Latest health status from the URL monitor: ``UNKNOWN`` (never
            checked yet), ``HEALTHY``, ``DEGRADED`` (intermittent failures,
            under the failure threshold), or ``UNREACHABLE`` (over the
            threshold). Read-only — set by the monitor, not the client.
        last_checked_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          description: >-
            ISO-8601 timestamp of the last health check, or null if never
            checked.
          title: Last Checked At
        organization_id:
          description: UUID of the organization that owns this custom URL.
          format: shortuuid
          maxLength: 22
          minLength: 22
          pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
          title: Organization Id
          type: string
        created:
          description: ISO-8601 creation timestamp.
          format: date-time
          title: Created
          type: string
        modified:
          description: ISO-8601 last-modified timestamp.
          format: date-time
          title: Modified
          type: string
      required:
        - id
        - url
        - status
        - organization_id
        - created
        - modified
      title: CustomURLOut
      type: object
    ErrorOut:
      description: |-
        RFC 9457 Problem Details response.

        All API errors are returned in this format with Content-Type:
        application/problem+json.
      examples:
        - detail: The requested resource was not found.
          error_code: not_found
          retryable: false
          status: 404
          timestamp: '2026-03-31T12:00:00+00:00'
          title: Not Found
          type: https://closient.com/docs/errors/not_found
        - detail: Validation error.
          details:
            - loc:
                - body
                - name
              msg: Field required
              type: missing
          error_code: validation_error
          retryable: false
          status: 422
          timestamp: '2026-03-31T12:00:00+00:00'
          title: Validation Error
          type: https://closient.com/docs/errors/validation_error
        - detail: Rate limit exceeded. Please try again later.
          error_code: rate_limited
          retry_after: 31
          retryable: true
          status: 429
          timestamp: '2026-03-31T12:00:00+00:00'
          title: Rate Limited
          type: https://closient.com/docs/errors/rate_limited
      properties:
        type:
          description: URI reference identifying the error type.
          title: Type
          type: string
        title:
          description: Short human-readable summary of the error.
          title: Title
          type: string
        status:
          description: HTTP status code.
          title: Status
          type: integer
        detail:
          description: Human-readable explanation of this specific occurrence.
          title: Detail
          type: string
        error_code:
          description: Machine-readable error code (e.g. not_found, unauthorized).
          title: Error Code
          type: string
        retryable:
          default: false
          description: Whether retrying the same request can succeed.
          title: Retryable
          type: boolean
        timestamp:
          description: ISO 8601 timestamp of when the error occurred.
          title: Timestamp
          type: string
        retry_after:
          anyOf:
            - type: integer
            - type: 'null'
          description: Seconds to wait before retrying (when applicable).
          title: Retry After
        owner_action_required:
          anyOf:
            - type: boolean
            - type: 'null'
          description: Whether the error requires account owner intervention.
          title: Owner Action Required
        details:
          description: Additional context (validation errors, etc.).
          title: Details
      required:
        - type
        - title
        - status
        - detail
        - error_code
        - timestamp
      title: ErrorOut
      type: object
    CustomURLStatusEnum:
      description: >-
        Health status of a custom-URL catalog entry (C-3339).


        Mirrors :class:`apps.resolver.models.CustomURLStatus`. ``UNKNOWN`` is
        the

        never-yet-checked default; ``HEALTHY`` / ``DEGRADED`` / ``UNREACHABLE``

        reflect the latest monitor result (degraded = intermittent failures
        under

        the failure threshold). Read-only over the API — set by the monitor.
      enum:
        - UNKNOWN
        - HEALTHY
        - DEGRADED
        - UNREACHABLE
      title: CustomURLStatusEnum
      type: string
  securitySchemes:
    APIKeyHeaderAuth:
      type: apiKey
      in: header
      name: X-API-Key
    OAuthTokenAuth:
      type: http
      scheme: bearer
    SessionAuth:
      type: apiKey
      in: cookie
      name: sessionid

````