Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added en/automation/api-credentials-list.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
55 changes: 55 additions & 0 deletions en/automation/api-credentials.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
---
title: "API credentials"
slug: api-credentials
---


This article provides details on CloudOps API credentials, and how to manage them.

## Overview

When working with the CloudOps API, you will need to generate an API key for use with your code. API keys provide a convenient method for your application to identify itself to a service when making calls to the service's API.

Any CloudOps user may generate an API key. A user's API keys will have the same level of privilege that the user has. There is no limit to the number of API keys that a user may generate. It is recommended to take advantage of this by generating an API key for each application that will be accessing the system.

API keys are created and managed in the **User Settings** panel, under the **API Credentials** section.

![Screenshot of the User Settings panel, with relevant features highlighted](api-credentials.png "The User Settings panel")

1. **User Settings menu**

Click this menu button to expose the User Settings panel.

2. **API Credentials**

Click on this to enter the API Credentials section of the User Settings panel.


## List existing API keys and endpoints

![Screenshot of the API Credentials section of the User Settings panel](api-credentials-list.png "The API Credentials section")

1. **Link to the API documentation**

Click on this link to open the CloudOps API documentation in a new tab.

2. **URL of the API endpoint**

Use this URL to access the CloudOps API.

3. **Existing keys**

All existing keys will be listed in this area of the panel. Each entry will have the name of the key, the IP address of the last client to use this key, and a timestamp of the last time the key was used. Click on the pencil icon to rename the key, or on the red circle icon to delete the key.


## Generate a new API key

See \[Generate a CloudOps API key\]\(../how-to/how-to-cloudmc-api-key\).

## Delete an API key

1. In the API Credentials panel, scroll down to see the existing keys and identify the API key to delete.
2. Click the red circle icon on the far right side of the desired entry.
3. A confirmation dialog box will appear. Click **Delete** to complete the operation.
4. The API key will be deleted immediately. It will disappear from the list of existing keys. Any attempt to login with that key will return an HTTP 401 error, and the body of the response will indicate invalid credentials.

Binary file added en/automation/api-credentials.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion en/automation/cloudmc_rest_api.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ In order to use the CloudOps API, you will start by logging into the system and

- [Generate a CloudOps API key](../how-to/how-to-cloudmc-api-key.md)

In addition to the API keys, the **API credentials** page will also list the URL to use when connecting to an endpoint.
In addition to the API keys, the **API credentials** page will also list the URL to use when connecting to an endpoint. See the [API Credentials](api-credentials.md) article for full details.

## API documentation

Expand Down
2 changes: 1 addition & 1 deletion en/basic-concepts/general-cloudmc_home_page.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ The CloudOps home page is the default page a user is presented with when logging

4. **Menu bar**

Across the top of all screens is the menu bar. The right-hand side of the menu bar contains three items: the help menu, the notifications menu, and the user menu.
Across the top of all screens is the menu bar. The right-hand side of the menu bar contains three items: the help menu, the notifications menu, and the User Settings menu.

5. **Collapse gadget**

Expand Down
39 changes: 39 additions & 0 deletions en/how-to/how-to-cloudmc-api-key-orig.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
title: "Generate a CloudOps API key"
slug: cloudmc-api-key
---


When working with the CloudOps API, you will need to generate an API key for use with your code. API keys provide a convenient method for your application to identify itself to a service when making calls to the service's API.

Any CloudOps user may generate an API key. A user's API keys will have the same level of privilege that the user has. There is no limit to the number of API keys that a user may generate. It is recommended to take advantage of this by generating an API key for each application that will be accessing the system.

To manage your API keys, navigate to the user menu on the upper right of the page, click on *My profile*, then click on the item labeled *API credentials*.

### List existing API keys and endpoints

![API credentials screen](/assets/cloudmc-api-key-en-01.png)

The *API credentials* screen lists all existing keys under the **API keys** section. The name of each key, the IP address from which it was used last, and the time and date it was last used are displayed.

To rename a key, click the icon labeled *Edit API key* icon on the far right side of the desired entry.

The endpoint for making API calls to the system is displayed above the list of keys. Click the clipboard icon to copy the URL into your clipboard.

### Generate a new API key

![API key generated](/assets/cloudmc-api-key-en-02.png)

1. From the *API credentials* screen, click the button labeled *Generate API key*.
1. Enter a name for the new key into the **Name** text field. You may wish to give the key a name which reflects the application it will be used for. Click *Generate*.
1. You will be returned to the *API credentials* screen. A notification will appear with the new API key hidden.
- You **must** retrieve the new key from this notification. Once the notification is dismissed, there is no way to display the API key again.
- Click the eye symbol to reveal the API key.
- Click the clipboard icon to copy the API key into your clipboard.
1. The API key is now ready for use. Store it in a secure location.

### Revoke an API key

1. From the *API credentials* screen, click the icon labeled *Revoke API key* on the far right side of the desired entry.
1. A confirmation dialog box will appear. Click *Revoke*.
1. The API key will be revoked immediately and is no longer valid for use.
40 changes: 18 additions & 22 deletions en/how-to/how-to-cloudmc-api-key.md
Original file line number Diff line number Diff line change
@@ -1,39 +1,35 @@
---
title: "Generate a CloudOps API key"
slug: cloudmc-api-key
slug: how-to-cloudmc-api-key
---


When working with the CloudOps API, you will need to generate an API key for use with your code. API keys provide a convenient method for your application to identify itself to a service when making calls to the service's API.
## About this task

Any CloudOps user may generate an API key. A user's API keys will have the same level of privilege that the user has. There is no limit to the number of API keys that a user may generate. It is recommended to take advantage of this by generating an API key for each application that will be accessing the system.
This article will guide you through the steps required to generate a key for accessing your account via the CloudOps API.

To manage your API keys, navigate to the user menu on the upper right of the page, click on *My profile*, then click on the item labeled *API credentials*.
## Before you begin

### List existing API keys and endpoints
- You must be logged into the CloudOps Web user interface

![API credentials screen](/assets/cloudmc-api-key-en-01.png)
## Procedure

The *API credentials* screen lists all existing keys under the **API keys** section. The name of each key, the IP address from which it was used last, and the time and date it was last used are displayed.
1. Click on the **User Settings** menu in the upper-right corner of the UI.

To rename a key, click the icon labeled *Edit API key* icon on the far right side of the desired entry.
2. When the User Settings drawer appears, click on **API Credentials**.

The endpoint for making API calls to the system is displayed above the list of keys. Click the clipboard icon to copy the URL into your clipboard.
3. Click on the **Generate API Key** button.

### Generate a new API key
4. When the key value appears, copy it by clicking on the clipboard icon.

![API key generated](/assets/cloudmc-api-key-en-02.png)
5. Click on the **Done** button. You may now close the User Settings drawer.

1. From the *API credentials* screen, click the button labeled *Generate API key*.
1. Enter a name for the new key into the **Name** text field. You may wish to give the key a name which reflects the application it will be used for. Click *Generate*.
1. You will be returned to the *API credentials* screen. A notification will appear with the new API key hidden.
- You **must** retrieve the new key from this notification. Once the notification is dismissed, there is no way to display the API key again.
- Click the eye symbol to reveal the API key.
- Click the clipboard icon to copy the API key into your clipboard.
1. The API key is now ready for use. Store it in a secure location.

### Revoke an API key
## Results

- The API key is now in your clipboard.

**Note:** Store your key securely. You will not be able to view it again in the UI after the User Settings drawer is closed.

- If you wish, you can rename your API key instead of using the randomly-generated default name.

1. From the *API credentials* screen, click the icon labeled *Revoke API key* on the far right side of the desired entry.
1. A confirmation dialog box will appear. Click *Revoke*.
1. The API key will be revoked immediately and is no longer valid for use.
2 changes: 1 addition & 1 deletion es/basic-concepts/general-cloudmc_home_page.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ La página de inicio de CloudOps es la página predeterminada que se le presenta

4. **La barra de menús**

En la parte superior de todas las pantallas se encuentra la barra de menú. El lado derecho de la barra de menú contiene tres elementos: el menú de ayuda, el menú de notificaciones y el menú de usuario.
En la parte superior de todas las pantallas se encuentra la barra de menú. El lado derecho de la barra de menú contiene tres elementos: el menú de ayuda, el menú de notificaciones y el menú de parámetros de usuario.

5. **El gadget de contracción**

Expand Down
2 changes: 1 addition & 1 deletion fr/basic-concepts/general-cloudmc_home_page.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ La page d'accueil CloudOps est la page par défaut qui s'affiche lorsqu'un utili

4. **La barre de menu**

En haut de tous les écrans se trouve la barre de menus. Le côté droit de la barre de menus contient trois éléments : le menu d'aide, le menu des notifications et le menu utilisateur.
En haut de tous les écrans se trouve la barre de menus. Le côté droit de la barre de menus contient trois éléments : le menu d'aide, le menu des notifications et le menu de paramètres de l'utilisateur.

5. **Le gadget de réduction**

Expand Down
1 change: 1 addition & 0 deletions layout.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -128,5 +128,6 @@ categories:
icon: fa fa-retweet
articles:
- cloudmc_rest_api.md
- api-credentials.md
- deploy-virtual-machine-using-terraform.md
- deploy-a-kubernetes-cluster-with-rancher-2-x.md
Loading