Introduction

This API list provides operations for interfacing with the Cohesity Cluster.

Getting Started with Helios

Authorization

Helios supports two types of authorization methods to access its functionalities:

1. Credentials (Username and Password)
2. API-Keys

1. Credentials Authorization

To authorize access using credentials, users need to sign in to Helios with their username and password. This method provides direct authentication and grants access to Helios features through UI.

Steps:

1. Navigate to the Helios login page.
2. Enter your username and password.
3. Click the "Sign In" button to authenticate.

2. API-Keys Authorization

API-Keys offer an alternative method for authorization in Helios. These keys can be created using the cookie details obtained through a standard login or via the Helios UI.

Steps:

1. Login to Helios:
   Access the Helios platform using your credentials (username and password).
2. Create API-Key:
   1. Through an API call:
      1. After successful login, retrieve the necessary cookie details.
      2. Utilize the obtained cookie details to generate an API-Key.
   2. Through UI:
      Navigate to the dedicated section for API key creation. Keep in mind that the generated key will be displayed only once, so it's crucial to securely store it for future use.

Multi-Factor Authentication (MFA)

For an added layer of security, Helios supports Multi-Factor Authentication. In addition to the standard credentials, users must provide a One-Time Password (OTP) to sign-in.

Do note that enabling MFA does not support automation

Note:

1. API-Keys provide a secure and convenient way to authorize access to Helios programmatically.
2. Ensure the confidentiality of your API-Keys and use them responsibly.

Getting Started with OnPrem

Authorization

OnPrem supports three distinct authorization methods for accessing its functionalities:

1. Access Token Authorization
2. Session ID Authorization
3. API Key Authorization

and all the above can have Multi-Factor Authentication (MFA) if enabled

1. Access Token Authorization

To use this method, users need to provide their credentials (username, password, and domain) to obtain an Access Token. This token can then be used in the header for subsequent API calls.

Steps:

1. Provide your username, password, and domain for authentication.
2. Obtain the Access Token.
3. Utilize the Access Token in the header for API calls.

2. Session ID Authorization

Another method involves using credentials (username, password, and domain) to obtain a Session ID. This Session ID is then used in the header for making API calls.

Steps:

1. Enter your username, password, and domain for authentication.
2. Retrieve the Session ID.
3. Include the Session ID in the header for API calls.

3. API-Keys Authorization

API-Keys offer an alternative method for authorization for OnPrem.

Steps:

1. Get session ID
2. Use the corresponding post api call to create an api-key
3. Include the API key in the header for API calls

Multi-Factor Authentication (MFA)

For an added layer of security, OnPrem supports Multi-Factor Authentication. In addition to the standard credentials, users must provide a One-Time Password (OTP) to obtain both the Access Token and Session ID.

Do note that enabling MFA does not support automation

Note:

1. Choose the appropriate authorization method based on your security and access requirements.
2. Ensure secure storage of tokens and credentials.

Example Workflows

Getting Views

Follow this Recipe to try to get views from your cluster.

Adding a Protection Job

Follow this Recipe to add a new protection job to your cluster.

Get Region IDs used

Follow this Recipe to get the Region IDs used by you.

Get Objects

Follow this Recipe to get the info on an object or objects given a Region ID.