Scaleway v1.37.0 published on Friday, Nov 7, 2025 by pulumiverse
scaleway.iam.getApiKey
Start a Neo task
Explain and create a scaleway.iam.getApiKey resource
Gets information about an existing IAM API key. For more information, refer to the IAM API documentation.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as scaleway from "@pulumiverse/scaleway";
// Get api key infos by id (access_key)
const main = scaleway.iam.getApiKey({
accessKey: "SCWABCDEFGHIJKLMNOPQ",
});
import pulumi
import pulumi_scaleway as scaleway
# Get api key infos by id (access_key)
main = scaleway.iam.get_api_key(access_key="SCWABCDEFGHIJKLMNOPQ")
package main
import (
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumiverse/pulumi-scaleway/sdk/go/scaleway/iam"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
// Get api key infos by id (access_key)
_, err := iam.LookupApiKey(ctx, &iam.LookupApiKeyArgs{
AccessKey: "SCWABCDEFGHIJKLMNOPQ",
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Scaleway = Pulumi.Scaleway;
return await Deployment.RunAsync(() =>
{
// Get api key infos by id (access_key)
var main = Scaleway.Iam.GetApiKey.Invoke(new()
{
AccessKey = "SCWABCDEFGHIJKLMNOPQ",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.scaleway.iam.IamFunctions;
import com.pulumi.scaleway.iam.inputs.GetApiKeyArgs;
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) {
// Get api key infos by id (access_key)
final var main = IamFunctions.getApiKey(GetApiKeyArgs.builder()
.accessKey("SCWABCDEFGHIJKLMNOPQ")
.build());
}
}
variables:
# Get api key infos by id (access_key)
main:
fn::invoke:
function: scaleway:iam:getApiKey
arguments:
accessKey: SCWABCDEFGHIJKLMNOPQ
Using getApiKey
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getApiKey(args: GetApiKeyArgs, opts?: InvokeOptions): Promise<GetApiKeyResult>
function getApiKeyOutput(args: GetApiKeyOutputArgs, opts?: InvokeOptions): Output<GetApiKeyResult>def get_api_key(access_key: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetApiKeyResult
def get_api_key_output(access_key: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetApiKeyResult]func LookupApiKey(ctx *Context, args *LookupApiKeyArgs, opts ...InvokeOption) (*LookupApiKeyResult, error)
func LookupApiKeyOutput(ctx *Context, args *LookupApiKeyOutputArgs, opts ...InvokeOption) LookupApiKeyResultOutput> Note: This function is named LookupApiKey in the Go SDK.
public static class GetApiKey
{
public static Task<GetApiKeyResult> InvokeAsync(GetApiKeyArgs args, InvokeOptions? opts = null)
public static Output<GetApiKeyResult> Invoke(GetApiKeyInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetApiKeyResult> getApiKey(GetApiKeyArgs args, InvokeOptions options)
public static Output<GetApiKeyResult> getApiKey(GetApiKeyArgs args, InvokeOptions options)
fn::invoke:
function: scaleway:iam/getApiKey:getApiKey
arguments:
# arguments dictionaryThe following arguments are supported:
- Access
Key string - The access key of the IAM API key which is also the ID of the API key.
- Access
Key string - The access key of the IAM API key which is also the ID of the API key.
- access
Key String - The access key of the IAM API key which is also the ID of the API key.
- access
Key string - The access key of the IAM API key which is also the ID of the API key.
- access_
key str - The access key of the IAM API key which is also the ID of the API key.
- access
Key String - The access key of the IAM API key which is also the ID of the API key.
getApiKey Result
The following output properties are available:
- Access
Key string - Application
Id string - Created
At string - Creation
Ip string - Default
Project stringId - Description string
- Editable bool
- Expires
At string - Id string
- The provider-assigned unique ID for this managed resource.
- Updated
At string - User
Id string
- Access
Key string - Application
Id string - Created
At string - Creation
Ip string - Default
Project stringId - Description string
- Editable bool
- Expires
At string - Id string
- The provider-assigned unique ID for this managed resource.
- Updated
At string - User
Id string
- access
Key String - application
Id String - created
At String - creation
Ip String - default
Project StringId - description String
- editable Boolean
- expires
At String - id String
- The provider-assigned unique ID for this managed resource.
- updated
At String - user
Id String
- access
Key string - application
Id string - created
At string - creation
Ip string - default
Project stringId - description string
- editable boolean
- expires
At string - id string
- The provider-assigned unique ID for this managed resource.
- updated
At string - user
Id string
- access_
key str - application_
id str - created_
at str - creation_
ip str - default_
project_ strid - description str
- editable bool
- expires_
at str - id str
- The provider-assigned unique ID for this managed resource.
- updated_
at str - user_
id str
- access
Key String - application
Id String - created
At String - creation
Ip String - default
Project StringId - description String
- editable Boolean
- expires
At String - id String
- The provider-assigned unique ID for this managed resource.
- updated
At String - user
Id String
Package Details
- Repository
- scaleway pulumiverse/pulumi-scaleway
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
scalewayTerraform Provider.
