1. Packages
  2. Equinix
  3. API Docs
  4. metal
  5. ProjectApiKey
Equinix v0.22.0 published on Wednesday, Apr 23, 2025 by Equinix

equinix.metal.ProjectApiKey

Explore with Pulumi AI

Use this resource to create Metal Project API Key resources in Equinix Metal. Project API keys can be used to create and read resources in a single project. Each API key contains a token which can be used for authentication in Equinix Metal HTTP API (in HTTP request header X-Auth-Token).

Read-only keys only allow to list and view existing resources, read-write keys can also be used to create resources.

Example Usage

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Equinix = Pulumi.Equinix;

return await Deployment.RunAsync(() => 
{
    var test = new Equinix.Metal.ProjectApiKey("test", new()
    {
        ProjectId = existingProjectId,
        Description = "Read-only key scoped to a projct",
        ReadOnly = true,
    });

});
Copy
package main

import (
	"github.com/equinix/pulumi-equinix/sdk/go/equinix/metal"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := metal.NewProjectApiKey(ctx, "test", &metal.ProjectApiKeyArgs{
			ProjectId:   pulumi.Any(existingProjectId),
			Description: pulumi.String("Read-only key scoped to a projct"),
			ReadOnly:    pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.equinix.metal.ProjectApiKey;
import com.pulumi.equinix.metal.ProjectApiKeyArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var test = new ProjectApiKey("test", ProjectApiKeyArgs.builder()
            .projectId(existingProjectId)
            .description("Read-only key scoped to a projct")
            .readOnly(true)
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as equinix from "@equinix-labs/pulumi-equinix";

const test = new equinix.metal.ProjectApiKey("test", {
    projectId: existingProjectId,
    description: "Read-only key scoped to a projct",
    readOnly: true,
});
Copy
import pulumi
import pulumi_equinix as equinix

test = equinix.metal.ProjectApiKey("test",
    project_id=existing_project_id,
    description="Read-only key scoped to a projct",
    read_only=True)
Copy
resources:
  # Create a new read-only API key in existing project
  test:
    type: equinix:metal:ProjectApiKey
    properties:
      projectId: ${existingProjectId}
      description: Read-only key scoped to a projct
      readOnly: true
Copy

Create ProjectApiKey Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new ProjectApiKey(name: string, args: ProjectApiKeyArgs, opts?: CustomResourceOptions);
@overload
def ProjectApiKey(resource_name: str,
                  args: ProjectApiKeyArgs,
                  opts: Optional[ResourceOptions] = None)

@overload
def ProjectApiKey(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  description: Optional[str] = None,
                  project_id: Optional[str] = None,
                  read_only: Optional[bool] = None)
func NewProjectApiKey(ctx *Context, name string, args ProjectApiKeyArgs, opts ...ResourceOption) (*ProjectApiKey, error)
public ProjectApiKey(string name, ProjectApiKeyArgs args, CustomResourceOptions? opts = null)
public ProjectApiKey(String name, ProjectApiKeyArgs args)
public ProjectApiKey(String name, ProjectApiKeyArgs args, CustomResourceOptions options)
type: equinix:metal:ProjectApiKey
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ProjectApiKeyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ProjectApiKeyArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ProjectApiKeyArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ProjectApiKeyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ProjectApiKeyArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var projectApiKeyResource = new Equinix.Metal.ProjectApiKey("projectApiKeyResource", new()
{
    Description = "string",
    ProjectId = "string",
    ReadOnly = false,
});
Copy
example, err := metal.NewProjectApiKey(ctx, "projectApiKeyResource", &metal.ProjectApiKeyArgs{
	Description: pulumi.String("string"),
	ProjectId:   pulumi.String("string"),
	ReadOnly:    pulumi.Bool(false),
})
Copy
var projectApiKeyResource = new ProjectApiKey("projectApiKeyResource", ProjectApiKeyArgs.builder()
    .description("string")
    .projectId("string")
    .readOnly(false)
    .build());
Copy
project_api_key_resource = equinix.metal.ProjectApiKey("projectApiKeyResource",
    description="string",
    project_id="string",
    read_only=False)
Copy
const projectApiKeyResource = new equinix.metal.ProjectApiKey("projectApiKeyResource", {
    description: "string",
    projectId: "string",
    readOnly: false,
});
Copy
type: equinix:metal:ProjectApiKey
properties:
    description: string
    projectId: string
    readOnly: false
Copy

ProjectApiKey Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The ProjectApiKey resource accepts the following input properties:

Description
This property is required.
Changes to this property will trigger replacement.
string
Description string for the Project API Key resource.

  • read-only - (Optional) Flag indicating whether the API key shoud be read-only.
ProjectId
This property is required.
Changes to this property will trigger replacement.
string
UUID of the project where the API key is scoped to.
ReadOnly
This property is required.
Changes to this property will trigger replacement.
bool
Flag indicating whether the API key shoud be read-only
Description
This property is required.
Changes to this property will trigger replacement.
string
Description string for the Project API Key resource.

  • read-only - (Optional) Flag indicating whether the API key shoud be read-only.
ProjectId
This property is required.
Changes to this property will trigger replacement.
string
UUID of the project where the API key is scoped to.
ReadOnly
This property is required.
Changes to this property will trigger replacement.
bool
Flag indicating whether the API key shoud be read-only
description
This property is required.
Changes to this property will trigger replacement.
String
Description string for the Project API Key resource.

  • read-only - (Optional) Flag indicating whether the API key shoud be read-only.
projectId
This property is required.
Changes to this property will trigger replacement.
String
UUID of the project where the API key is scoped to.
readOnly
This property is required.
Changes to this property will trigger replacement.
Boolean
Flag indicating whether the API key shoud be read-only
description
This property is required.
Changes to this property will trigger replacement.
string
Description string for the Project API Key resource.

  • read-only - (Optional) Flag indicating whether the API key shoud be read-only.
projectId
This property is required.
Changes to this property will trigger replacement.
string
UUID of the project where the API key is scoped to.
readOnly
This property is required.
Changes to this property will trigger replacement.
boolean
Flag indicating whether the API key shoud be read-only
description
This property is required.
Changes to this property will trigger replacement.
str
Description string for the Project API Key resource.

  • read-only - (Optional) Flag indicating whether the API key shoud be read-only.
project_id
This property is required.
Changes to this property will trigger replacement.
str
UUID of the project where the API key is scoped to.
read_only
This property is required.
Changes to this property will trigger replacement.
bool
Flag indicating whether the API key shoud be read-only
description
This property is required.
Changes to this property will trigger replacement.
String
Description string for the Project API Key resource.

  • read-only - (Optional) Flag indicating whether the API key shoud be read-only.
projectId
This property is required.
Changes to this property will trigger replacement.
String
UUID of the project where the API key is scoped to.
readOnly
This property is required.
Changes to this property will trigger replacement.
Boolean
Flag indicating whether the API key shoud be read-only

Outputs

All input properties are implicitly available as output properties. Additionally, the ProjectApiKey resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Token string
API token which can be used in Equinix Metal API clients
Id string
The provider-assigned unique ID for this managed resource.
Token string
API token which can be used in Equinix Metal API clients
id String
The provider-assigned unique ID for this managed resource.
token String
API token which can be used in Equinix Metal API clients
id string
The provider-assigned unique ID for this managed resource.
token string
API token which can be used in Equinix Metal API clients
id str
The provider-assigned unique ID for this managed resource.
token str
API token which can be used in Equinix Metal API clients
id String
The provider-assigned unique ID for this managed resource.
token String
API token which can be used in Equinix Metal API clients

Look up Existing ProjectApiKey Resource

Get an existing ProjectApiKey resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ProjectApiKeyState, opts?: CustomResourceOptions): ProjectApiKey
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        project_id: Optional[str] = None,
        read_only: Optional[bool] = None,
        token: Optional[str] = None) -> ProjectApiKey
func GetProjectApiKey(ctx *Context, name string, id IDInput, state *ProjectApiKeyState, opts ...ResourceOption) (*ProjectApiKey, error)
public static ProjectApiKey Get(string name, Input<string> id, ProjectApiKeyState? state, CustomResourceOptions? opts = null)
public static ProjectApiKey get(String name, Output<String> id, ProjectApiKeyState state, CustomResourceOptions options)
resources:  _:    type: equinix:metal:ProjectApiKey    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Description Changes to this property will trigger replacement. string
Description string for the Project API Key resource.

  • read-only - (Optional) Flag indicating whether the API key shoud be read-only.
ProjectId Changes to this property will trigger replacement. string
UUID of the project where the API key is scoped to.
ReadOnly Changes to this property will trigger replacement. bool
Flag indicating whether the API key shoud be read-only
Token string
API token which can be used in Equinix Metal API clients
Description Changes to this property will trigger replacement. string
Description string for the Project API Key resource.

  • read-only - (Optional) Flag indicating whether the API key shoud be read-only.
ProjectId Changes to this property will trigger replacement. string
UUID of the project where the API key is scoped to.
ReadOnly Changes to this property will trigger replacement. bool
Flag indicating whether the API key shoud be read-only
Token string
API token which can be used in Equinix Metal API clients
description Changes to this property will trigger replacement. String
Description string for the Project API Key resource.

  • read-only - (Optional) Flag indicating whether the API key shoud be read-only.
projectId Changes to this property will trigger replacement. String
UUID of the project where the API key is scoped to.
readOnly Changes to this property will trigger replacement. Boolean
Flag indicating whether the API key shoud be read-only
token String
API token which can be used in Equinix Metal API clients
description Changes to this property will trigger replacement. string
Description string for the Project API Key resource.

  • read-only - (Optional) Flag indicating whether the API key shoud be read-only.
projectId Changes to this property will trigger replacement. string
UUID of the project where the API key is scoped to.
readOnly Changes to this property will trigger replacement. boolean
Flag indicating whether the API key shoud be read-only
token string
API token which can be used in Equinix Metal API clients
description Changes to this property will trigger replacement. str
Description string for the Project API Key resource.

  • read-only - (Optional) Flag indicating whether the API key shoud be read-only.
project_id Changes to this property will trigger replacement. str
UUID of the project where the API key is scoped to.
read_only Changes to this property will trigger replacement. bool
Flag indicating whether the API key shoud be read-only
token str
API token which can be used in Equinix Metal API clients
description Changes to this property will trigger replacement. String
Description string for the Project API Key resource.

  • read-only - (Optional) Flag indicating whether the API key shoud be read-only.
projectId Changes to this property will trigger replacement. String
UUID of the project where the API key is scoped to.
readOnly Changes to this property will trigger replacement. Boolean
Flag indicating whether the API key shoud be read-only
token String
API token which can be used in Equinix Metal API clients

Package Details

Repository
equinix equinix/pulumi-equinix
License
Apache-2.0
Notes
This Pulumi package is based on the equinix Terraform Provider.