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

# List the refused writes to a log

> Writes the engine refused, kept beside the log, most recent first: who sent them, in which role, based on which entry, their commands and the refusal.



## OpenAPI

````yaml /openapi.json get /rsl/{id}/logs/{log}/refusals
openapi: 3.0.3
info:
  title: Effective API
  version: 2.0.0
  description: The public Effective REST API. Authenticate using an Effective API key.
servers:
  - url: https://api.canary.effectiveai.app/api/v2
    description: Canary
security:
  - bearerAuth: []
paths:
  /rsl/{id}/logs/{log}/refusals:
    get:
      tags:
        - Your programs
      summary: List the refused writes to a log
      description: >-
        Writes the engine refused, kept beside the log, most recent first: who
        sent them, in which role, based on which entry, their commands and the
        refusal.
      operationId: listProgramLogRefusals
      parameters:
        - schema:
            type: string
            minLength: 1
            maxLength: 128
            pattern: ^[a-z0-9][a-z0-9._-]{0,127}$
            description: >-
              Your organization’s ID for the program, chosen at its first
              upload: lowercase letters, digits, dots, underscores and hyphens.
              A rater’s program ID is its rater ID.
          required: true
          description: >-
            Your organization’s ID for the program, chosen at its first upload:
            lowercase letters, digits, dots, underscores and hyphens. A rater’s
            program ID is its rater ID.
          name: id
          in: path
        - schema:
            type: string
            format: uuid
            description: >-
              The log’s id: a UUID the caller chooses when it opens the log,
              such as the id of the case the log decides. One id has one log.
          required: true
          description: >-
            The log’s id: a UUID the caller chooses when it opens the log, such
            as the id of the case the log decides. One id has one log.
          name: log
          in: path
        - schema:
            type: integer
            minimum: 1
            maximum: 200
            default: 50
            description: Most refusals to return, 1–200. Defaults to 50.
          required: false
          description: Most refusals to return, 1–200. Defaults to 50.
          name: limit
          in: query
      responses:
        '200':
          description: The refused writes.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LogRefusals'
        '400':
          description: Invalid log, query or cursor.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '401':
          description: Authentication required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '403':
          description: >-
            The caller cannot read the program, as the program’s own call routes
            refuse it.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '404':
          description: The log is not opened on this program, or the caller cannot read it.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
      security:
        - bearerAuth: []
components:
  schemas:
    LogRefusals:
      type: object
      properties:
        refusals:
          type: array
          items:
            type: object
            properties:
              at:
                type: string
              by:
                $ref: '#/components/schemas/LogActor'
              basedOn:
                type: integer
                nullable: true
              commands:
                type: array
                items:
                  nullable: true
                description: The write’s commands, as sent.
              refusal:
                type: object
                properties:
                  code:
                    type: string
                    maxLength: 64
                    pattern: ^[A-Z][A-Z0-9_]*$
                    description: >-
                      The engine’s refusal code: ALREADY_OPEN, NOT_OPEN,
                      PROGRAM_CHANGED, CLOSED, UNKNOWN_ROLE, NOT_AUTHORIZED,
                      BAD_PATH, INVALID_VALUE, REASON_REQUIRED, NOT_REFERRED,
                      NOT_ANSWERED, NOT_A_TERM, NOT_DECLINABLE, NOT_QUOTABLE,
                      NOT_QUOTED, STALE, or one a newer engine added. STALE is
                      answered as 409, every other code as 422.
                  message:
                    type: string
                    maxLength: 4000
                    description: What was wrong, and what to do.
                  candidates:
                    type: array
                    items:
                      type: string
                      maxLength: 500
                    maxItems: 200
                    description: 'What would be accepted here: values, roles or questions.'
                required:
                  - code
                  - message
                additionalProperties: false
            required:
              - at
              - by
              - basedOn
              - commands
              - refusal
      required:
        - refusals
    V2CodedError:
      allOf:
        - $ref: '#/components/schemas/V2Error'
        - type: object
          properties:
            code:
              type: string
              minLength: 1
              description: Stable error code. Clients must tolerate unknown future codes.
            details:
              type: array
              items:
                type: object
                properties:
                  location:
                    type: string
                    enum:
                      - path
                      - query
                      - header
                      - body
                  path:
                    type: array
                    items:
                      type: string
                      maxLength: 64
                    maxItems: 12
                  code:
                    type: string
                    enum:
                      - required
                      - invalid_type
                      - invalid_value
                      - unknown_field
                  message:
                    type: string
                    minLength: 1
                    maxLength: 200
                required:
                  - location
                  - path
                  - code
                  - message
              minItems: 1
              maxItems: 20
              description: Bounded safe validation issues; may omit some invalid fields.
            requestId:
              type: string
              minLength: 1
              maxLength: 128
              description: >-
                Existing server correlation for this HTTP attempt, when
                available.
            dataset:
              type: string
              enum:
                - naic
                - osha
              description: Dataset needed for dataset_not_enabled.
            businessCode:
              type: string
              description: The rater’s own refusal code, for business_rejection.
            violations:
              type: array
              items:
                type: object
                properties:
                  code:
                    type: string
                    description: Authored or built-in constraint code
                  message:
                    type: string
                    description: Authored message for the failed constraint
                  path:
                    type: string
                    description: Input path of the offending value; empty for the request
                  value:
                    nullable: true
                    description: Offending input value, size-bounded by the runtime
                  constraint:
                    type: string
                    description: The constraint the value failed, as text
                  cite:
                    type: string
                    nullable: true
                    description: >-
                      Filing citation of the constraint, when the source cites
                      one
                required:
                  - code
                  - message
                  - path
                  - value
                  - constraint
                  - cite
                additionalProperties: false
              maxItems: 256
              description: >-
                Each input constraint the submission failed, for invalid_inputs
                and business_rejection.
            violationsTruncated:
              type: boolean
              description: >-
                True when the rater reported more violations than violations
                holds.
            executionId:
              type: string
              description: >-
                The recorded execution of a failed rating, for rater rating
                failures.
            accessUrl:
              type: string
              nullable: true
              format: uri
              description: Not currently returned.
          required:
            - code
    LogActor:
      type: object
      properties:
        role:
          type: string
          description: The program role written in.
        id:
          type: string
          description: 'Who wrote: the user.'
      required:
        - role
        - id
    V2Error:
      type: object
      properties:
        error:
          type: string
          minLength: 1
          description: Human-readable explanation of the failure.
      required:
        - error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Effective API key. Send Authorization: Bearer sk-eai-...'

````

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