Endpoint management

If you don't have the Nebius Israel command line interface yet, install and initialize it.

The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.

To get a list of transfers in a folder, run the following command:

yc datatransfer endpoint list

Use the API list method.

If you don't have the Nebius Israel command line interface yet, install and initialize it.

The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.

To create an endpoint:

1. View a description of the CLI create endpoint command:

   yc datatransfer endpoint create --help
   

2. Specify the endpoint parameters in the create command (only some of the supported parameters are given in the example):

   yc datatransfer endpoint create <endpoint type> \
      --name <endpoint name> \
      --description <endpoint description> \
      <endpoint parameters>
   

   You can view the endpoint type and parameters in the settings section for the appropriate data source or target.

With Terraform, you can quickly create a cloud infrastructure in Nebius Israel and manage it using configuration files. They store the infrastructure description in HashiCorp Configuration Language (HCL). Terraform and its providers are distributed under the Business Source License.

For more information about the provider resources, see the documentation on the Terraform website.

If you change the configuration files, Terraform automatically determines which part of your configuration is already deployed and what should be added or removed.

If you do not have Terraform, install it and configure the provider.

To create an endpoint:

1. Create a configuration file with a description of your endpoint.

   Example of the configuration file structure:

   resource "ycp_datatransfer_endpoint" "<endpoint name in Terraform>" {
     name = "<endpoint name>"
     settings {
       <endpoint type> {
         <endpoint parameters>
       }
     }
   }
   

You can retrieve a complete resource schema by running terraform providers schema.

1. You can view the endpoint type and parameters in the settings section for the appropriate data source or target.

2. Make sure the settings are correct.

   1. Using the command line, navigate to the folder that contains the up-to-date Terraform configuration files with an infrastructure plan.

   2. Run the command:

      terraform validate
      

      If there are errors in the configuration files, Terraform will point to them.

3. Confirm that the resources have been updated.

   1. Run the command to view planned changes:

      terraform plan
      

      If the resource configuration descriptions are correct, the terminal will display a list of the resources to modify and their parameters. This is a test step. No resources are updated.

   2. If you are happy with the planned changes, apply them:

      1. Run the command:

         terraform apply
         

      2. Confirm the update of resources.

      3. Wait for the operation to complete.

4. For more information, see the Terraform provider documentation.

Use the create API method and include the following information in the request:

• ID of the folder to host the endpoint, in the folderId parameter.
• Endpoint name in the name parameter.
• Endpoint description in the description parameter.
• Endpoint parameters in the settings parameter.

You can view the endpoint parameters in the settings section for the appropriate data source or target.

If you don't have the Nebius Israel command line interface yet, install and initialize it.

The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.

To update the endpoint settings:

1. View a description of the update transfer CLI command:

   yc datatransfer endpoint update --help
   

2. Run the following command by providing a list of the settings to change (the example below does not contain a full list of parameters):

   yc datatransfer transfer update <endpoint type> <endpoint ID> \
      --name <endpoint name> \
      --description <endpoint description> \
      <endpoint parameters>
   

   You can view the endpoint type and parameters in the settings section for the appropriate data source or target. You can get the endpoint ID with a list of endpoints in the folder.

1. Open the current Terraform configuration file with the endpoint description.

   To learn how to create such a file, see Create endpoint.

2. Edit the value in the name field (endpoint name) and the endpoint parameters under settings.

3. Make sure the settings are correct.

   1. Using the command line, navigate to the folder that contains the up-to-date Terraform configuration files with an infrastructure plan.

   2. Run the command:

      terraform validate
      

      If there are errors in the configuration files, Terraform will point to them.

4. Confirm that the resources have been updated.

   1. Run the command to view planned changes:

      terraform plan
      

      If the resource configuration descriptions are correct, the terminal will display a list of the resources to modify and their parameters. This is a test step. No resources are updated.

   2. If you are happy with the planned changes, apply them:

      1. Run the command:

         terraform apply
         

      2. Confirm the update of resources.

      3. Wait for the operation to complete.

For more information, see the Terraform provider documentation.

Use the update API method and include the following in the request:

• Endpoint ID in the endpointId parameters.
• Endpoint name in the name parameter.
• Endpoint description in the description parameter.
• Endpoint parameters in the settings parameter.

You can get the endpoint ID with a list of endpoints in the folder.

If you don't have the Nebius Israel command line interface yet, install and initialize it.

The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.

To delete an endpoint, run the command:

yc datatransfer endpoint delete <endpoint ID>

You can get the endpoint ID with a list of endpoints in the folder.

To delete an endpoint created using Terraform:

1. Open the current Terraform configuration file with an infrastructure plan.

   For more information about creating this file, see Creating an endpoint.

2. Make sure that the endpoint being deleted is not bound to a transfer.

3. Delete the endpoint description.

4. Make sure the settings are correct.

   1. Using the command line, navigate to the folder that contains the up-to-date Terraform configuration files with an infrastructure plan.

   2. Run the command:

      terraform validate
      

      If there are errors in the configuration files, Terraform will point to them.

5. Type the word yes, then press Enter.

   1. Run the command to view planned changes:

      terraform plan
      

      If the resource configuration descriptions are correct, the terminal will display a list of the resources to modify and their parameters. This is a test step. No resources are updated.

   2. If you are happy with the planned changes, apply them:

      1. Run the command:

         terraform apply
         

      2. Confirm the update of resources.

      3. Wait for the operation to complete.

For more information, see the Terraform provider documentation.

Use the delete API method and provide the ID of the required endpoint in the endpointID request parameter.

You can get the endpoint ID with a list of endpoints in the folder.