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

# Administrar claves de API

> ClickHouse Cloud proporciona una API basada en OpenAPI que le permite administrar mediante programación su cuenta y ciertos aspectos de sus servicios.

export const Image = ({img, alt, size = "lg"}) => {
  const normalizedSize = ["sm", "md", "lg"].includes(size) ? size : "lg";
  return <div className={`ch-image-${normalizedSize}`}>
      <Frame>
        <img src={img} alt={alt} />
      </Frame>
    </div>;
};

ClickHouse Cloud proporciona una API basada en OpenAPI que le permite administrar mediante programación su cuenta y ciertos aspectos de sus servicios.

<Note>
  Este documento describe la ClickHouse Cloud API. Para los endpoints de la API de bases de datos, consulte [Cloud Endpoints API](/docs/es/products/cloud/guides/sql-console/query-endpoints)
</Note>

<Steps>
  <Step title="Abra la página API Keys">
    Puede usar la pestaña **API Keys** del menú de la izquierda para crear y administrar sus claves de API.

    <Image img="https://mintcdn.com/private-7c7dfe99/REHSqgCLT_igIuJP/images/cloud/manage/openapi1.webp?fit=max&auto=format&n=REHSqgCLT_igIuJP&q=85&s=4b5e224e02e9995b15f410c0b53cc5e7" size="sm" alt="Pestaña API Keys" border width="433" height="472" data-path="images/cloud/manage/openapi1.webp" />
  </Step>

  <Step title="Empiece a crear una clave de API">
    La página **API Keys** mostrará inicialmente un mensaje para crear su primera clave de API, como se muestra a continuación. Después de crear su primera clave, puede crear nuevas claves con el botón `New API Key` que aparece en la esquina superior derecha.

    <Image img="https://mintcdn.com/private-7c7dfe99/REHSqgCLT_igIuJP/images/cloud/manage/openapi2.webp?fit=max&auto=format&n=REHSqgCLT_igIuJP&q=85&s=3ad9d02d51c9ac4c8b0649027ccf61ec" size="md" alt="Página API Keys" border width="1036" height="466" data-path="images/cloud/manage/openapi2.webp" />
  </Step>

  <Step title="Configure la clave de API">
    Especifique el nombre de la clave, sus permisos y el tiempo de expiración.

    <Note>
      Los permisos se corresponden con los [roles predefinidos](/docs/es/products/cloud/reference/security/console-roles) de ClickHouse Cloud. El rol de desarrollador tiene permisos de solo lectura para los servicios asignados y el rol de administrador tiene permisos completos de lectura y escritura.
    </Note>

    <Tip>
      **Query API Endpoints**

      Para usar claves de API con [Query API Endpoints](/docs/es/products/cloud/guides/sql-console/query-endpoints), establezca Organization Role en `Member` (como mínimo) y conceda al Service Role acceso a `Query Endpoints`.
    </Tip>

    <Image img="https://mintcdn.com/private-7c7dfe99/C7EtYbvQvbHPGmL5/images/cloud/manage/openapi3.png?fit=max&auto=format&n=C7EtYbvQvbHPGmL5&q=85&s=d85d50665cb229cce53ba16a82a27cd1" size="md" alt="Formulario para crear una clave de API" border width="661" height="410" data-path="images/cloud/manage/openapi3.png" />
  </Step>

  <Step title="Agregue direcciones IP permitidas">
    Para restringir qué clientes pueden usar la clave de API, en la sección **Allow access to this API Key**, seleccione **Specific locations**. Introduzca una dirección IP o un rango CIDR, como `203.0.113.1` o `203.0.113.0/24`, y agregue entradas adicionales según sea necesario.

    Los Query API endpoints respetan las listas de IP permitidas a nivel de clave de API. Como las solicitudes se enrutan mediante proxy desde la infraestructura interna de ClickHouse, las listas de IP permitidas a nivel de servicio no se aplican. Consulte [IP Access Control](/docs/es/cloud/features/query-api-endpoints#ip-access-control) para obtener más información.

    <Image img="https://mintcdn.com/private-7c7dfe99/A68-kVUDkVcT2W3b/images/cloud/guides/query-endpoints/specific-locations.webp?fit=max&auto=format&n=A68-kVUDkVcT2W3b&q=85&s=db3d75c39aa5c3e73bc0d23dad7ae25c" size="md" alt="Direcciones IP permitidas configuradas para una clave de API" border width="1336" height="1740" data-path="images/cloud/guides/query-endpoints/specific-locations.webp" />

    Haga clic en **Generate API Key** cuando haya terminado de configurar la clave.
  </Step>

  <Step title="Guarde las credenciales de la clave de API">
    La siguiente pantalla mostrará su ID de clave y el secreto de la clave. Copie estos valores y guárdelos en un lugar seguro, como una bóveda. Estos valores no volverán a mostrarse después de salir de esta pantalla.

    <Image img="https://mintcdn.com/private-7c7dfe99/REHSqgCLT_igIuJP/images/cloud/manage/openapi4.webp?fit=max&auto=format&n=REHSqgCLT_igIuJP&q=85&s=5872535bb69a2299c88f38c627ead497" size="md" alt="Detalles de la clave de API" border width="653" height="271" data-path="images/cloud/manage/openapi4.webp" />
  </Step>

  <Step title="Autentique las solicitudes de API">
    La ClickHouse Cloud API usa [autenticación básica HTTP](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication) para verificar la validez de sus claves de API. A continuación, se muestra un ejemplo de cómo usar sus claves de API para enviar solicitudes a la ClickHouse Cloud API con `curl`:

    ```bash theme={null}
    $ KEY_ID=mykeyid
    $ KEY_SECRET=mykeysecret

    $ curl --user $KEY_ID:$KEY_SECRET https://api.clickhouse.cloud/v1/organizations
    ```
  </Step>

  <Step title="Administre las claves de API existentes">
    Al volver a la página **API Keys**, verá el nombre de la clave, los últimos cuatro caracteres del ID de clave, los permisos, el estado, la fecha de expiración y el creador. Desde esta pantalla puede editar el nombre de la clave, los permisos y la expiración. También puede deshabilitar o eliminar claves desde esta pantalla.

    <Note>
      Eliminar una clave de API es una acción permanente. Cualquier servicio que use la clave perderá inmediatamente el acceso a ClickHouse Cloud.
    </Note>

    <Image img="https://mintcdn.com/private-7c7dfe99/REHSqgCLT_igIuJP/images/cloud/manage/openapi5.webp?fit=max&auto=format&n=REHSqgCLT_igIuJP&q=85&s=e81ed237b99933a115f931acc919c8f8" size="md" alt="Página de administración de API Keys" border width="1092" height="335" data-path="images/cloud/manage/openapi5.webp" />
  </Step>
</Steps>

<div id="endpoints">
  ## Endpoints
</div>

Para obtener más información sobre los endpoints, consulta la [Referencia de la API](/docs/es/products/cloud/api-reference/organization/get-list-of-available-organizations).
Usa tu clave de API y tu secreto de API con la URL base `https://api.clickhouse.cloud/v1`.