---
updatedAt: 2025-04-03T21:41:30.000Z
agentTools:
  projectIndex: https://replicated.readme.io/llms.txt
---

# Console API

Console API provides API functionality against console settings.

## /console/v1/option

Returns values corresponding to the given console option name.

### Request paramerters

<Table align={["left","left","left"]}>
  <thead>
    <tr>
      <th>
        Name
      </th>

      <th>
        Type
      </th>

      <th>
        Description
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        name
      </td>

      <td>
        String
      </td>

      <td>
        Option name
      </td>
    </tr>
  </tbody>
</Table>

### Response Status

<Table align={["left","left"]}>
  <thead>
    <tr>
      <th>
        Status
      </th>

      <th>
        Description
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        200
      </td>

      <td>
        Success
      </td>
    </tr>

    <tr>
      <td>
        400
      </td>

      <td>
        Bad request
      </td>
    </tr>
  </tbody>
</Table>

### Response body

Option value (string)

## /console/v1/auth

Authenticates against the console authentication settings.

### Request payload

<Table align={["left","left","left"]}>
  <thead>
    <tr>
      <th>
        Name
      </th>

      <th>
        Type
      </th>

      <th>
        Description
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        username
      </td>

      <td>
        String
      </td>

      <td>
        Username (required only for authentication type LDAP)
      </td>
    </tr>

    <tr>
      <td>
        password
      </td>

      <td>
        String
      </td>

      <td>
        Password
      </td>
    </tr>
  </tbody>
</Table>

### Response Status

<Table align={["left","left"]}>
  <thead>
    <tr>
      <th>
        Status
      </th>

      <th>
        Description
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        200
      </td>

      <td>
        Authentication successful
      </td>
    </tr>

    <tr>
      <td>
        400
      </td>

      <td>
        Bad request
      </td>
    </tr>

    <tr>
      <td>
        401
      </td>

      <td>
        Invalid authentication credentials
      </td>
    </tr>
  </tbody>
</Table>

### Response body

no content