github.com/phrase/openapi@v0.0.0-20240514140800-49e8a106740e/paths/blacklisted_keys/index.yaml (about)

     1  ---
     2  summary: List blocked keys
     3  description: List all rules for blocking keys for the given project.
     4  operationId: blacklisted_keys/list
     5  tags:
     6  - Blacklisted Keys
     7  parameters:
     8  - "$ref": "../../parameters.yaml#/X-PhraseApp-OTP"
     9  - "$ref": "../../parameters.yaml#/project_id"
    10  - "$ref": "../../parameters.yaml#/page"
    11  - "$ref": "../../parameters.yaml#/per_page"
    12  - description: specify the branch to use
    13    example: my-feature-branch
    14    name: branch
    15    in: query
    16    schema:
    17      type: string
    18  responses:
    19    '200':
    20      description: OK
    21      content:
    22        application/json:
    23          schema:
    24            type: array
    25            items:
    26              "$ref": "../../schemas/blacklisted_key.yaml#/blacklisted_key"
    27      headers:
    28        X-Rate-Limit-Limit:
    29          "$ref": "../../headers.yaml#/X-Rate-Limit-Limit"
    30        X-Rate-Limit-Remaining:
    31          "$ref": "../../headers.yaml#/X-Rate-Limit-Remaining"
    32        X-Rate-Limit-Reset:
    33          "$ref": "../../headers.yaml#/X-Rate-Limit-Reset"
    34        Link:
    35          "$ref": "../../headers.yaml#/Link"
    36        Pagination:
    37          "$ref": "../../headers.yaml#/Pagination"
    38    '400':
    39      "$ref": "../../responses.yaml#/400"
    40    '404':
    41      "$ref": "../../responses.yaml#/404"
    42    '429':
    43      "$ref": "../../responses.yaml#/429"
    44  x-code-samples:
    45  - lang: Curl
    46    source: |-
    47      curl "https://api.phrase.com/v2/projects/:project_id/blacklisted_keys" \
    48        -u USERNAME_OR_ACCESS_TOKEN
    49  - lang: CLI v2
    50    source: |-
    51      phrase blacklisted_keys list \
    52      --project_id <project_id> \
    53      --access_token <token>
    54  x-cli-version: '2.5'