Template

Struct Template 

Source
pub struct Template {
Show 18 fields pub id: String, pub name: String, pub image_name: String, pub is_public: bool, pub is_runpod: bool, pub is_serverless: bool, pub category: Option<TemplateCategory>, pub container_disk_in_gb: i32, pub container_registry_auth_id: Option<String>, pub docker_entrypoint: Option<Vec<String>>, pub docker_start_cmd: Option<Vec<String>>, pub earned: Option<f64>, pub env: Option<EnvVars>, pub ports: Option<Vec<String>>, pub readme: Option<String>, pub runtime_in_min: Option<i32>, pub volume_in_gb: i32, pub volume_mount_path: String,
}
Expand description

Template resource containing deployment configuration and metadata.

A Template is a reusable configuration that defines how Pods and Serverless endpoints should be deployed, including Docker image, resource requirements, environment variables, and networking settings.

§Template Lifecycle

  1. Creation: Define template with TemplateCreateInput
  2. Usage: Reference template when creating Pods or Serverless endpoints
  3. Updates: Modify template with TemplateUpdateInput (triggers rolling releases)
  4. Sharing: Make public to share with community and earn revenue
  5. Management: Track usage statistics and earnings through template metadata

§Revenue Model

Public templates can generate revenue for their creators:

  • Users pay standard RunPod rates for compute resources
  • Template creators earn a percentage of compute costs
  • Earnings are tracked in the earned field

Fields§

§id: String

A unique string identifying the template. This ID is used to reference the template when creating Pods or Serverless endpoints.

§name: String

A user-defined name for the template. The name must be unique within your account and should be descriptive of the template’s purpose or use case.

§image_name: String

The Docker image tag for containers deployed from this template. Can reference public images from Docker Hub, private registry images, or images from other container registries with appropriate authentication.

§is_public: bool

Whether the template is visible to other RunPod users.

  • true: Template is public and can be used by any RunPod user
  • false: Template is private and only accessible to the creator
§is_runpod: bool

Whether this is an official template managed by RunPod. Official templates are curated, maintained, and optimized by the RunPod team for popular frameworks and use cases.

§is_serverless: bool

Whether the template is designed for Serverless workers or Pods.

  • true: Template creates Serverless workers (auto-scaling, event-driven)
  • false: Template creates Pods (persistent, long-running instances)
§category: Option<TemplateCategory>

The compute category of resources defined by this template. Determines the type of hardware acceleration available to deployed instances.

§container_disk_in_gb: i32

The amount of disk space, in gigabytes (GB), allocated on the container disk. Container disk provides fast local storage but data is wiped when instances restart. Use for temporary files, caches, and application data that doesn’t need persistence.

§container_registry_auth_id: Option<String>

The unique identifier for container registry authentication. Required when the template uses private Docker images that need authentication to pull from protected container registries.

§docker_entrypoint: Option<Vec<String>>

Override for the Docker image ENTRYPOINT. If specified, replaces the ENTRYPOINT defined in the Docker image. If None or empty, uses the ENTRYPOINT from the Docker image.

§docker_start_cmd: Option<Vec<String>>

Override for the Docker image start command. If specified, replaces the CMD defined in the Docker image. If None or empty, uses the CMD from the Docker image.

§earned: Option<f64>

The total RunPod credits earned by the template creator. Represents cumulative earnings from all Pods and Serverless workers created from this template by other users. Only applies to public templates.

§env: Option<EnvVars>

Environment variables to be set in containers deployed from this template. These variables are available to the running application and can be used for configuration, secrets management, and runtime customization.

§ports: Option<Vec<String>>

A list of ports exposed on deployed Pods or Serverless workers. Each port is formatted as [port number]/[protocol] where protocol can be either http or tcp. Example: ["8888/http", "22/tcp"]

§readme: Option<String>

Markdown-formatted documentation for the template. Displayed in the RunPod UI when users browse or select templates. Should include usage instructions, requirements, and configuration details.

§runtime_in_min: Option<i32>

Runtime statistics for the template (in minutes). Tracks total runtime across all instances deployed from this template. Used for usage analytics and optimization insights.

§volume_in_gb: i32

The amount of disk space, in gigabytes (GB), allocated on the local Pod volume. Pod volume provides persistent local storage that survives instance restarts. Use for data, models, and files that need to persist across restarts.

§volume_mount_path: String

The absolute filesystem path where the Pod volume is mounted. This is where the persistent storage will be accessible within the container. Common paths include /workspace, /data, or /app/storage.

Trait Implementations§

Source§

impl Clone for Template

Source§

fn clone(&self) -> Template

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Template

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for Template

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for Template

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,