# Create a Hyperscale Mount Point

Endpoint: POST /hyperscale-mount-points
Version: 3.23.0
Security: ApiKeyAuth

## Security:

  - `ApiKeyAuth` (unknown)
    apiKey in header Authorization

## Request body:

  - `application/json` (unknown)
    Request to create a Hyperscale Mount Point.

## Request fields (application/json):

  - `hyperscale_instance_id` (string, required)
    The ID of the Hyperscale instance of this Mount Point.

  - `name` (string)
    Name of the mount, unique for a hyperscale instance. This name will be used as a directory name by the Hyperscale instance.

  - `hostname` (string)
    The host name of the server.

  - `mount_path` (string)
    The path to the directory on the filesystem to mount.

  - `mount_type` (string)
    The type of mount filesystem. Enum having values- CIFS, NFS3, NFS4.
    Enum: "CIFS", "NFS3", "NFS4"

  - `options` (string)
    The options for mount. The endpoint will return all default options and user specified options.

  - `staging_storage_type` (string)
    The type of staging storage.
    Enum: "MOUNT", "AWS_S3", "AZURE_BLOB_STORAGE"

  - `auth_mechanism` (string)
    The authentication mechanism for AWS_S3 storage.
    Enum: "AWS_ROLE", "AWS_SECRET"

  - `aws_bucket_name` (string)
    The aws bucket name for AWS_S3 storage.

  - `aws_bucket_region` (string)
    The aws bucket region for AWS_S3 storage.

  - `aws_bucket_prefix` (string)
    The aws bucket prefix for AWS_S3 storage.

  - `aws_bucket_delimiter` (string)
    The aws bucket delimiter for AWS_S3 storage.

  - `blob_auth_type` (string)
    The authentication type for Azure blob storage.
    Enum: "AZURE_SECRET", "AZURE_MANAGED_IDENTITY"

  - `blob_account_name` (string)
    The storage account name for Azure blob storage.

  - `blob_container_name` (string)
    The blob container name for Azure blob storage.

  - `blob_container_prefix` (string)
    The blob container prefix for Azure blob storage.

  - `blob_container_delimiter` (string)
    The blob container delimiter for Azure blob storage.

## Response 200:

  - `200` (unknown)
    OK

## Response 200 fields (application/json):

  - `id` (string)
    The created Hyperscale Mount Point's ID

  - `job` (object)
    An asynchronous task.

  - `job.id` (string)
    The Job entity ID.
    Example: job-123

  - `job.status` (string)
    The status of the job.
    Enum: "PENDING", "STARTED", "TIMEDOUT", "RUNNING", "CANCELED", "FAILED", "SUSPENDED", "WAITING", "COMPLETED", "ABANDONED"

  - `job.is_waiting_for_telemetry` (boolean)
    Indicates that the operations performed by this Job have completed successfully, but the object changes are not yet reflected. This is only set when when the JOB is in STARTED status, with the guarantee that the job will not transition to the FAILED status. Note that this flag will likely be replaced with a new status in future API versions and be deprecated.

  - `job.type` (string)
    The type of job being done.
    Example: DB_REFRESH

  - `job.localized_type` (string)
    The i18n translated type of job being done.
    Example: DB Refresh

  - `job.error_details` (string)
    Details about the failure for FAILED jobs.
    Example: Unable to connect to the engine.

  - `job.warning_message` (string)
    Warnings for the job.
    Example: Failed to remove local MaskingJob, engineId: 3 localMaskingJobId: 7.

  - `job.target_id` (string)
    A reference to the job's target.
    Example: vdb-123

  - `job.target_name` (string)
    A reference to the job's target name.
    Example: vdb

  - `job.start_time` (string)
    The time the job started executing.
    Example: 2022-01-02T05:11:24.148000+00:00

  - `job.update_time` (string)
    The time the job was last updated.
    Example: 2022-01-02T06:11:24.148000+00:00

  - `job.trace_id` (string)
    traceId of the request which created this Job

  - `job.engine_ids` (array)
    IDs of the engines this Job is executing on.

  - `job.tags` (array)

  - `job.tags.key` (string, required)
    Key of the tag
    Example: key-1

  - `job.tags.value` (string, required)
    Value of the tag
    Example: value-1

  - `job.engines` (array)

  - `job.engines.engine_id` (string)

  - `job.engines.engine_name` (string)

  - `job.account_id` (integer)
    The ID of the account who initiated this job.
    Example: 1

  - `job.account_name` (string)
    The account name which initiated this job. It can be either firstname and lastname combination or firstname or lastname or username or email address or Account-.
    Example: User 1

  - `job.percent_complete` (integer)
    Completion percentage of the Job.
    Example: 50

  - `job.virtualization_tasks` (array)

  - `job.virtualization_tasks.id` (string)

  - `job.virtualization_tasks.parent_job_id` (string)

  - `job.virtualization_tasks.start_time` (string)

  - `job.virtualization_tasks.end_time` (string)

  - `job.virtualization_tasks.title` (string)

  - `job.virtualization_tasks.percent_complete` (integer)

  - `job.virtualization_tasks.events` (array)

  - `job.virtualization_tasks.events.message_details` (string)

  - `job.virtualization_tasks.status` (string)
    Enum: "PENDING", "STARTED", "TIMEDOUT", "RUNNING", "CANCELED", "FAILED", "SUSPENDED", "WAITING", "COMPLETED", "ABANDONED"

  - `job.tasks` (array)

  - `job.tasks.id` (string)

  - `job.tasks.parent_job_id` (string)

  - `job.tasks.start_time` (string)

  - `job.tasks.end_time` (string)

  - `job.tasks.title` (string)

  - `job.tasks.percent_complete` (integer)

  - `job.tasks.events` (array)

  - `job.tasks.events.message_details` (string)

  - `job.tasks.status` (string)
    Enum: "PENDING", "STARTED", "TIMEDOUT", "RUNNING", "CANCELED", "FAILED", "SUSPENDED", "WAITING", "COMPLETED", "ABANDONED"

  - `job.execution_id` (string)
    The ID of the associated masking execution, if any.

  - `job.result_type` (string)
    The type of the job result. This is the type of the object present in the result.

  - `job.result` (object)
    The result of the job execution. This is JSON serialized string of the result object whose type is specified by result_type property.