@nebius/js-sdk - v0.1.41
    Preparing search index...

    Interface EndpointSpec

    EndpointSpec defines a endpoint that will be run.

    interface EndpointSpec {
        "[customJson]"?: () => unknown;
        "[unknownFieldsSymbol]"?: Uint8Array<ArrayBufferLike>;
        $type: "nebius.ai.v1.EndpointSpec";
        args: string;
        authToken: string;
        containerCommand: string;
        disk?: EndpointSpec_DiskSpec;
        environmentVariables: EndpointSpec_EnvironmentVariable[];
        image: string;
        platform: string;
        ports: EndpointSpec_Port[];
        preemptible: boolean;
        preset: string;
        publicIp: boolean;
        registryCredentials?: EndpointSpec_RegistryCredentials;
        shmSizeBytes: Long;
        sshAuthorizedKeys: string[];
        subnetId: string;
        volumes: EndpointSpec_VolumeMount[];
        workingDir: string;
        [key: symbol]: Uint8Array<ArrayBufferLike> | (() => unknown) | undefined;
    }

    Indexable

    • [key: symbol]: Uint8Array<ArrayBufferLike> | (() => unknown) | undefined
    Index

    Properties

    [customJson]? [unknownFieldsSymbol]? $type args authToken containerCommand disk? environmentVariables image platform ports preemptible preset publicIp registryCredentials? shmSizeBytes sshAuthorizedKeys subnetId volumes workingDir

    Properties

    "[customJson]"?: () => unknown
    "[unknownFieldsSymbol]"?: Uint8Array<ArrayBufferLike>
    $type: "nebius.ai.v1.EndpointSpec"
    args: string

    The arguments to pass to the entrypoint command.

    authToken: string

    Authentication token needed to access the endpoint.

    Authentication can only be enabled if the endpoint exposes one and only one HTTP port.

    If not provided, a authentication will be disabled.

    containerCommand: string

    The entrypoint command for the endpoint's container.

    disk?: EndpointSpec_DiskSpec

    Disk spec for the main disk of the endpoint.

    environmentVariables: EndpointSpec_EnvironmentVariable[]

    Specifies the environment variables for the endpoint's container.

    image: string

    The Docker image to use for the endpoint's container.

    platform: string

    Compute platform that the endpoint will be run on.

    ports: EndpointSpec_Port[]

    Specifies the ports that the endpoint exposes.

    preemptible: boolean

    Whether to use a preemptible VM for the endpoint. Preemptible VMs are cheaper but can be stopped by the platform at any time.

    preset: string

    Compute preset that the endpoint will be run on.

    publicIp: boolean

    Whether to assign a public IP to the endpoint.

    registryCredentials?: EndpointSpec_RegistryCredentials

    Registry credentials for private Docker registry.

    shmSizeBytes: Long

    Shared memory size in bytes for the endpoint's container.

    sshAuthorizedKeys: string[]

    Public keys to be authorized for SSH access to the job.

    subnetId: string

    Subnet ID where the endpoint will be deployed.

    volumes: EndpointSpec_VolumeMount[]

    Volumes to be mounted into the endpoint's container.

    workingDir: string

    The working directory for the endpoint's container.

    Settings

    Member Visibility

    On This Page

    Properties