Skip to content

Create Dataset

POST
/datasets/
curl --request POST \
  --url 'https://api.e2enetworks.com/myaccount/api/v1/gpu/datasets/?project_id=<PROJECT_ID>&location=<LOCATION>&apikey=<API_KEY>' \
  --header 'Authorization: Bearer <API_TOKEN>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "string",
  "storage_type": "managed",
  "pvc": {
    "disk_size": 0,
    "pvc_type": "string"
  },
  "bucket": {
    "bucket_name": "string",
    "endpoint": "string"
  },
  "access_key": {
    "access_key": "string",
    "secret_key": "string"
  },
  "encryption_enable": false,
  "encryption_type": "sse-kms",
  "description": "string"
}'

Create a new dataset with one of three storage types:

  • managed: System creates and manages a new EOS bucket
  • existing_bucket: Connect to an existing EOS bucket with provided credentials
  • pvc: Create a dataset with disk storage

Optionally supports encryption (SSE-KMS or SSE-C) for managed and existing_bucket types.

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
project_id
required
integer

Project ID

active_iam
integer

Active IAM ID (To access contact person account) Find your Active IAM ID here

location
required
string
Allowed values: Delhi Chennai

Location

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
name
required

Name of the dataset

string
storage_type
required

Type of storage for the dataset

string
Allowed values: managed pvc existing_bucket
pvc

PVC configuration, required if storage_type is pvc

object
disk_size
required

Disk size for the PVC in GB

integer
pvc_type
required

Type of the PVC

string
bucket

Bucket configuration, required if storage_type is existing_bucket

object
bucket_name
required

Name of the existing bucket

string
endpoint
required

Endpoint URL of the object store

string
access_key

Access key configuration, required if storage_type is existing_bucket

object
access_key
required

Access key for the bucket

string
secret_key
required

Secret key for the bucket

string
encryption_enable

Whether to enable encryption

boolean
encryption_type

Type of encryption to use (required if encryption_enable is true):

  • sse-kms: Server-side encryption with KMS (E2E managed)
  • sse-c: Server-side encryption with customer-provided keys (user managed)
string
Allowed values: sse-kms sse-c
description

Optional description of the dataset

string

Responses

Section titled “Responses”

201

Section titled “201”

Success response indicating that the dataset was created.

Media typeapplication/json
object
code

HTTP status code for the operation.

integer
data
object
id

Unique identifier of the dataset.

integer
name

Name of the dataset.

string
project_id

ID of the project associated with the dataset.

integer
description

Description of the dataset, which is null in this case.

string
nullable
storage_type

Type of storage used for the dataset.

string
pvc

Persistent volume claim (PVC) details, which is null in this case.

string
nullable
bucket
object
id

Unique identifier of the bucket.

integer
bucket_name

Name of the storage bucket.

string
bucket_url

URL of the bucket.

string
endpoint

Endpoint URL of the object store.

string
is_managed

Whether the bucket is managed.

boolean
eos_bucket_permission_id

EOS bucket permission ID.

integer
access_key
object
id

Unique identifier for the access key.

integer
access_key

The access key.

string
secret_key

The secret key for accessing the bucket.

string
tag

A tag associated with the access key.

string
is_managed

Whether the access key is managed.

boolean
encryption_type

Type of encryption used, which is null in this case.

string
nullable
encryption_enable

Whether encryption is enabled for the dataset.

boolean
status

Status of the dataset.

string
created_by
object
id

User ID of the creator.

integer
name

Name of the creator.

string
email

Email of the creator.

string
username

Username of the creator.

string
created_at

Timestamp of when the dataset was created.

string format: date-time
updated_at

Timestamp of when the dataset was last updated.

string format: date-time
errors

Any errors encountered during the operation.

object
message

Message indicating the result of the operation.

string

Example 

{
  "code": 201,
  "data": {
    "id": 1310,
    "name": "eos-bucket",
    "project_id": 124,
    "storage_type": "managed",
    "bucket": {
      "id": 2525,
      "bucket_name": "d-gpu-b4273173-e5ab-4a85-ad89-dc8d6e698a93",
      "bucket_url": "s3://d-gpu-b4273173-e5ab-4a85-ad89-dc8d6e698a93/",
      "endpoint": "https://objectstore.e2enetworks.net",
      "is_managed": true,
      "eos_bucket_permission_id": 10214
    },
    "access_key": {
      "id": 2542,
      "access_key": "FWXL9EZZWS4BBSX9512V",
      "secret_key": "ZB3PM8XBNQGG4PFVDEI5915IO1TZHCFGEIO2LID9",
      "tag": "akgpu50a522c13dcd4708a5dbf6ae3da98bfa",
      "is_managed": true
    },
    "encryption_enable": false,
    "status": "Pending",
    "created_by": {
      "id": 3573,
      "name": "Nipun",
      "email": "nipun.arora@e2enetworks.com",
      "username": "nipun.arora@e2enetworks.com"
    },
    "created_at": "2024-11-14T12:57:36.293942Z",
    "updated_at": "2024-11-14T12:57:36.293994Z"
  },
  "errors": {},
  "message": "Created Successfully"
}

© E2E Networks Limited · CIN L72900DL2009PLC341980