1. Packages
  2. NS1
  3. API Docs
  4. APIKey
NS1 v3.1.0 published on Tuesday, Sep 19, 2023 by Pulumi

ns1.APIKey

Explore with Pulumi AI

ns1 logo
NS1 v3.1.0 published on Tuesday, Sep 19, 2023 by Pulumi

    Provides a NS1 Api Key resource. This can be used to create, modify, and delete api keys.

    Permissions

    An API key will inherit permissions from the teams it is assigned to. If a key is assigned to a team and also has individual permissions set on the key, the individual permissions will be overridden by the inherited team permissions. In a future release, setting permissions on a key that is part of a team will be explicitly disabled.

    When a key is removed from all teams completely, it will inherit whatever permissions it had previously. If a key is removed from all it’s teams, it will probably be necessary to run pulumi up a second time to update the keys permissions from it’s old team permissions to new key-specific permissions.

    See the NS1 API docs for an overview of permission semantics or for more details about the individual permission flags.

    NS1 Documentation

    ApiKeys Api Doc

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Ns1 = Pulumi.Ns1;
    
    return await Deployment.RunAsync(() => 
    {
        var exampleTeam = new Ns1.Team("exampleTeam");
    
        var exampleAPIKey = new Ns1.APIKey("exampleAPIKey", new()
        {
            Teams = new[]
            {
                exampleTeam.Id,
            },
            IpWhitelists = new[]
            {
                "1.1.1.1",
                "2.2.2.2",
            },
            DnsViewZones = false,
            AccountManageUsers = false,
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-ns1/sdk/v3/go/ns1"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		exampleTeam, err := ns1.NewTeam(ctx, "exampleTeam", nil)
    		if err != nil {
    			return err
    		}
    		_, err = ns1.NewAPIKey(ctx, "exampleAPIKey", &ns1.APIKeyArgs{
    			Teams: pulumi.StringArray{
    				exampleTeam.ID(),
    			},
    			IpWhitelists: pulumi.StringArray{
    				pulumi.String("1.1.1.1"),
    				pulumi.String("2.2.2.2"),
    			},
    			DnsViewZones:       pulumi.Bool(false),
    			AccountManageUsers: pulumi.Bool(false),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.ns1.Team;
    import com.pulumi.ns1.APIKey;
    import com.pulumi.ns1.APIKeyArgs;
    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 exampleTeam = new Team("exampleTeam");
    
            var exampleAPIKey = new APIKey("exampleAPIKey", APIKeyArgs.builder()        
                .teams(exampleTeam.id())
                .ipWhitelists(            
                    "1.1.1.1",
                    "2.2.2.2")
                .dnsViewZones(false)
                .accountManageUsers(false)
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_ns1 as ns1
    
    example_team = ns1.Team("exampleTeam")
    example_api_key = ns1.APIKey("exampleAPIKey",
        teams=[example_team.id],
        ip_whitelists=[
            "1.1.1.1",
            "2.2.2.2",
        ],
        dns_view_zones=False,
        account_manage_users=False)
    
    import * as pulumi from "@pulumi/pulumi";
    import * as ns1 from "@pulumi/ns1";
    
    const exampleTeam = new ns1.Team("exampleTeam", {});
    const exampleAPIKey = new ns1.APIKey("exampleAPIKey", {
        teams: [exampleTeam.id],
        ipWhitelists: [
            "1.1.1.1",
            "2.2.2.2",
        ],
        dnsViewZones: false,
        accountManageUsers: false,
    });
    
    resources:
      exampleTeam:
        type: ns1:Team
      exampleAPIKey:
        type: ns1:APIKey
        properties:
          teams:
            - ${exampleTeam.id}
          # Optional IP whitelist
          ipWhitelists:
            - 1.1.1.1
            - 2.2.2.2
          # Configure permissions
          dnsViewZones: false
          accountManageUsers: false
    

    Create APIKey Resource

    new APIKey(name: string, args?: APIKeyArgs, opts?: CustomResourceOptions);
    @overload
    def APIKey(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               account_manage_account_settings: Optional[bool] = None,
               account_manage_apikeys: Optional[bool] = None,
               account_manage_ip_whitelist: Optional[bool] = None,
               account_manage_payment_methods: Optional[bool] = None,
               account_manage_plan: Optional[bool] = None,
               account_manage_teams: Optional[bool] = None,
               account_manage_users: Optional[bool] = None,
               account_view_activity_log: Optional[bool] = None,
               account_view_invoices: Optional[bool] = None,
               data_manage_datafeeds: Optional[bool] = None,
               data_manage_datasources: Optional[bool] = None,
               data_push_to_datafeeds: Optional[bool] = None,
               dhcp_manage_dhcp: Optional[bool] = None,
               dhcp_view_dhcp: Optional[bool] = None,
               dns_manage_zones: Optional[bool] = None,
               dns_records_allows: Optional[Sequence[APIKeyDnsRecordsAllowArgs]] = None,
               dns_records_denies: Optional[Sequence[APIKeyDnsRecordsDenyArgs]] = None,
               dns_view_zones: Optional[bool] = None,
               dns_zones_allow_by_default: Optional[bool] = None,
               dns_zones_allows: Optional[Sequence[str]] = None,
               dns_zones_denies: Optional[Sequence[str]] = None,
               ip_whitelist_strict: Optional[bool] = None,
               ip_whitelists: Optional[Sequence[str]] = None,
               ipam_manage_ipam: Optional[bool] = None,
               ipam_view_ipam: Optional[bool] = None,
               monitoring_manage_jobs: Optional[bool] = None,
               monitoring_manage_lists: Optional[bool] = None,
               monitoring_view_jobs: Optional[bool] = None,
               name: Optional[str] = None,
               security_manage_active_directory: Optional[bool] = None,
               security_manage_global2fa: Optional[bool] = None,
               teams: Optional[Sequence[str]] = None)
    @overload
    def APIKey(resource_name: str,
               args: Optional[APIKeyArgs] = None,
               opts: Optional[ResourceOptions] = None)
    func NewAPIKey(ctx *Context, name string, args *APIKeyArgs, opts ...ResourceOption) (*APIKey, error)
    public APIKey(string name, APIKeyArgs? args = null, CustomResourceOptions? opts = null)
    public APIKey(String name, APIKeyArgs args)
    public APIKey(String name, APIKeyArgs args, CustomResourceOptions options)
    
    type: ns1:APIKey
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args APIKeyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args APIKeyArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args APIKeyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args APIKeyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args APIKeyArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    APIKey Resource Properties

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

    Inputs

    The APIKey resource accepts the following input properties:

    AccountManageAccountSettings bool

    Whether the apikey can modify account settings.

    AccountManageApikeys bool

    Whether the apikey can modify account apikeys.

    AccountManageIpWhitelist bool

    Whether the apikey can manage ip whitelist.

    AccountManagePaymentMethods bool

    Whether the apikey can modify account payment methods.

    AccountManagePlan bool

    No longer in use.

    Deprecated:

    obsolete, should no longer be used

    AccountManageTeams bool

    Whether the apikey can modify other teams in the account.

    AccountManageUsers bool

    Whether the apikey can modify account users.

    AccountViewActivityLog bool

    Whether the apikey can view activity logs.

    AccountViewInvoices bool

    Whether the apikey can view invoices.

    DataManageDatafeeds bool

    Whether the apikey can modify data feeds.

    DataManageDatasources bool

    Whether the apikey can modify data sources.

    DataPushToDatafeeds bool

    Whether the apikey can publish to data feeds.

    DhcpManageDhcp bool

    Whether the apikey can manage DHCP. Only relevant for the DDI product.

    DhcpViewDhcp bool

    Whether the apikey can view DHCP. Only relevant for the DDI product.

    DnsManageZones bool

    Whether the apikey can modify the accounts zones.

    DnsRecordsAllows List<APIKeyDnsRecordsAllow>

    List of records that the apikey may access.

    DnsRecordsDenies List<APIKeyDnsRecordsDeny>

    List of records that the apikey may not access.

    DnsViewZones bool

    Whether the apikey can view the accounts zones.

    DnsZonesAllowByDefault bool

    If true, enable the dns_zones_allow list, otherwise enable the dns_zones_deny list.

    DnsZonesAllows List<string>

    List of zones that the apikey may access.

    DnsZonesDenies List<string>

    List of zones that the apikey may not access.

    IpWhitelistStrict bool

    Set to true to restrict access to only those IP addresses and networks listed in the ip_whitelist field.

    IpWhitelists List<string>

    Array of IP addresses/networks to which to grant the API key access.

    IpamManageIpam bool

    Whether the apikey can manage IPAM. Only relevant for the DDI product.

    IpamViewIpam bool

    Whether the apikey can view IPAM. Only relevant for the DDI product.

    MonitoringManageJobs bool

    Whether the apikey can modify monitoring jobs.

    MonitoringManageLists bool

    Whether the apikey can modify notification lists.

    MonitoringViewJobs bool

    Whether the apikey can view monitoring jobs.

    Name string

    The free form name of the apikey.

    SecurityManageActiveDirectory bool

    Whether the apikey can manage global active directory. Only relevant for the DDI product.

    SecurityManageGlobal2fa bool

    Whether the apikey can manage global two factor authentication.

    Teams List<string>

    The teams that the apikey belongs to.

    AccountManageAccountSettings bool

    Whether the apikey can modify account settings.

    AccountManageApikeys bool

    Whether the apikey can modify account apikeys.

    AccountManageIpWhitelist bool

    Whether the apikey can manage ip whitelist.

    AccountManagePaymentMethods bool

    Whether the apikey can modify account payment methods.

    AccountManagePlan bool

    No longer in use.

    Deprecated:

    obsolete, should no longer be used

    AccountManageTeams bool

    Whether the apikey can modify other teams in the account.

    AccountManageUsers bool

    Whether the apikey can modify account users.

    AccountViewActivityLog bool

    Whether the apikey can view activity logs.

    AccountViewInvoices bool

    Whether the apikey can view invoices.

    DataManageDatafeeds bool

    Whether the apikey can modify data feeds.

    DataManageDatasources bool

    Whether the apikey can modify data sources.

    DataPushToDatafeeds bool

    Whether the apikey can publish to data feeds.

    DhcpManageDhcp bool

    Whether the apikey can manage DHCP. Only relevant for the DDI product.

    DhcpViewDhcp bool

    Whether the apikey can view DHCP. Only relevant for the DDI product.

    DnsManageZones bool

    Whether the apikey can modify the accounts zones.

    DnsRecordsAllows []APIKeyDnsRecordsAllowArgs

    List of records that the apikey may access.

    DnsRecordsDenies []APIKeyDnsRecordsDenyArgs

    List of records that the apikey may not access.

    DnsViewZones bool

    Whether the apikey can view the accounts zones.

    DnsZonesAllowByDefault bool

    If true, enable the dns_zones_allow list, otherwise enable the dns_zones_deny list.

    DnsZonesAllows []string

    List of zones that the apikey may access.

    DnsZonesDenies []string

    List of zones that the apikey may not access.

    IpWhitelistStrict bool

    Set to true to restrict access to only those IP addresses and networks listed in the ip_whitelist field.

    IpWhitelists []string

    Array of IP addresses/networks to which to grant the API key access.

    IpamManageIpam bool

    Whether the apikey can manage IPAM. Only relevant for the DDI product.

    IpamViewIpam bool

    Whether the apikey can view IPAM. Only relevant for the DDI product.

    MonitoringManageJobs bool

    Whether the apikey can modify monitoring jobs.

    MonitoringManageLists bool

    Whether the apikey can modify notification lists.

    MonitoringViewJobs bool

    Whether the apikey can view monitoring jobs.

    Name string

    The free form name of the apikey.

    SecurityManageActiveDirectory bool

    Whether the apikey can manage global active directory. Only relevant for the DDI product.

    SecurityManageGlobal2fa bool

    Whether the apikey can manage global two factor authentication.

    Teams []string

    The teams that the apikey belongs to.

    accountManageAccountSettings Boolean

    Whether the apikey can modify account settings.

    accountManageApikeys Boolean

    Whether the apikey can modify account apikeys.

    accountManageIpWhitelist Boolean

    Whether the apikey can manage ip whitelist.

    accountManagePaymentMethods Boolean

    Whether the apikey can modify account payment methods.

    accountManagePlan Boolean

    No longer in use.

    Deprecated:

    obsolete, should no longer be used

    accountManageTeams Boolean

    Whether the apikey can modify other teams in the account.

    accountManageUsers Boolean

    Whether the apikey can modify account users.

    accountViewActivityLog Boolean

    Whether the apikey can view activity logs.

    accountViewInvoices Boolean

    Whether the apikey can view invoices.

    dataManageDatafeeds Boolean

    Whether the apikey can modify data feeds.

    dataManageDatasources Boolean

    Whether the apikey can modify data sources.

    dataPushToDatafeeds Boolean

    Whether the apikey can publish to data feeds.

    dhcpManageDhcp Boolean

    Whether the apikey can manage DHCP. Only relevant for the DDI product.

    dhcpViewDhcp Boolean

    Whether the apikey can view DHCP. Only relevant for the DDI product.

    dnsManageZones Boolean

    Whether the apikey can modify the accounts zones.

    dnsRecordsAllows List<APIKeyDnsRecordsAllow>

    List of records that the apikey may access.

    dnsRecordsDenies List<APIKeyDnsRecordsDeny>

    List of records that the apikey may not access.

    dnsViewZones Boolean

    Whether the apikey can view the accounts zones.

    dnsZonesAllowByDefault Boolean

    If true, enable the dns_zones_allow list, otherwise enable the dns_zones_deny list.

    dnsZonesAllows List<String>

    List of zones that the apikey may access.

    dnsZonesDenies List<String>

    List of zones that the apikey may not access.

    ipWhitelistStrict Boolean

    Set to true to restrict access to only those IP addresses and networks listed in the ip_whitelist field.

    ipWhitelists List<String>

    Array of IP addresses/networks to which to grant the API key access.

    ipamManageIpam Boolean

    Whether the apikey can manage IPAM. Only relevant for the DDI product.

    ipamViewIpam Boolean

    Whether the apikey can view IPAM. Only relevant for the DDI product.

    monitoringManageJobs Boolean

    Whether the apikey can modify monitoring jobs.

    monitoringManageLists Boolean

    Whether the apikey can modify notification lists.

    monitoringViewJobs Boolean

    Whether the apikey can view monitoring jobs.

    name String

    The free form name of the apikey.

    securityManageActiveDirectory Boolean

    Whether the apikey can manage global active directory. Only relevant for the DDI product.

    securityManageGlobal2fa Boolean

    Whether the apikey can manage global two factor authentication.

    teams List<String>

    The teams that the apikey belongs to.

    accountManageAccountSettings boolean

    Whether the apikey can modify account settings.

    accountManageApikeys boolean

    Whether the apikey can modify account apikeys.

    accountManageIpWhitelist boolean

    Whether the apikey can manage ip whitelist.

    accountManagePaymentMethods boolean

    Whether the apikey can modify account payment methods.

    accountManagePlan boolean

    No longer in use.

    Deprecated:

    obsolete, should no longer be used

    accountManageTeams boolean

    Whether the apikey can modify other teams in the account.

    accountManageUsers boolean

    Whether the apikey can modify account users.

    accountViewActivityLog boolean

    Whether the apikey can view activity logs.

    accountViewInvoices boolean

    Whether the apikey can view invoices.

    dataManageDatafeeds boolean

    Whether the apikey can modify data feeds.

    dataManageDatasources boolean

    Whether the apikey can modify data sources.

    dataPushToDatafeeds boolean

    Whether the apikey can publish to data feeds.

    dhcpManageDhcp boolean

    Whether the apikey can manage DHCP. Only relevant for the DDI product.

    dhcpViewDhcp boolean

    Whether the apikey can view DHCP. Only relevant for the DDI product.

    dnsManageZones boolean

    Whether the apikey can modify the accounts zones.

    dnsRecordsAllows APIKeyDnsRecordsAllow[]

    List of records that the apikey may access.

    dnsRecordsDenies APIKeyDnsRecordsDeny[]

    List of records that the apikey may not access.

    dnsViewZones boolean

    Whether the apikey can view the accounts zones.

    dnsZonesAllowByDefault boolean

    If true, enable the dns_zones_allow list, otherwise enable the dns_zones_deny list.

    dnsZonesAllows string[]

    List of zones that the apikey may access.

    dnsZonesDenies string[]

    List of zones that the apikey may not access.

    ipWhitelistStrict boolean

    Set to true to restrict access to only those IP addresses and networks listed in the ip_whitelist field.

    ipWhitelists string[]

    Array of IP addresses/networks to which to grant the API key access.

    ipamManageIpam boolean

    Whether the apikey can manage IPAM. Only relevant for the DDI product.

    ipamViewIpam boolean

    Whether the apikey can view IPAM. Only relevant for the DDI product.

    monitoringManageJobs boolean

    Whether the apikey can modify monitoring jobs.

    monitoringManageLists boolean

    Whether the apikey can modify notification lists.

    monitoringViewJobs boolean

    Whether the apikey can view monitoring jobs.

    name string

    The free form name of the apikey.

    securityManageActiveDirectory boolean

    Whether the apikey can manage global active directory. Only relevant for the DDI product.

    securityManageGlobal2fa boolean

    Whether the apikey can manage global two factor authentication.

    teams string[]

    The teams that the apikey belongs to.

    account_manage_account_settings bool

    Whether the apikey can modify account settings.

    account_manage_apikeys bool

    Whether the apikey can modify account apikeys.

    account_manage_ip_whitelist bool

    Whether the apikey can manage ip whitelist.

    account_manage_payment_methods bool

    Whether the apikey can modify account payment methods.

    account_manage_plan bool

    No longer in use.

    Deprecated:

    obsolete, should no longer be used

    account_manage_teams bool

    Whether the apikey can modify other teams in the account.

    account_manage_users bool

    Whether the apikey can modify account users.

    account_view_activity_log bool

    Whether the apikey can view activity logs.

    account_view_invoices bool

    Whether the apikey can view invoices.

    data_manage_datafeeds bool

    Whether the apikey can modify data feeds.

    data_manage_datasources bool

    Whether the apikey can modify data sources.

    data_push_to_datafeeds bool

    Whether the apikey can publish to data feeds.

    dhcp_manage_dhcp bool

    Whether the apikey can manage DHCP. Only relevant for the DDI product.

    dhcp_view_dhcp bool

    Whether the apikey can view DHCP. Only relevant for the DDI product.

    dns_manage_zones bool

    Whether the apikey can modify the accounts zones.

    dns_records_allows Sequence[APIKeyDnsRecordsAllowArgs]

    List of records that the apikey may access.

    dns_records_denies Sequence[APIKeyDnsRecordsDenyArgs]

    List of records that the apikey may not access.

    dns_view_zones bool

    Whether the apikey can view the accounts zones.

    dns_zones_allow_by_default bool

    If true, enable the dns_zones_allow list, otherwise enable the dns_zones_deny list.

    dns_zones_allows Sequence[str]

    List of zones that the apikey may access.

    dns_zones_denies Sequence[str]

    List of zones that the apikey may not access.

    ip_whitelist_strict bool

    Set to true to restrict access to only those IP addresses and networks listed in the ip_whitelist field.

    ip_whitelists Sequence[str]

    Array of IP addresses/networks to which to grant the API key access.

    ipam_manage_ipam bool

    Whether the apikey can manage IPAM. Only relevant for the DDI product.

    ipam_view_ipam bool

    Whether the apikey can view IPAM. Only relevant for the DDI product.

    monitoring_manage_jobs bool

    Whether the apikey can modify monitoring jobs.

    monitoring_manage_lists bool

    Whether the apikey can modify notification lists.

    monitoring_view_jobs bool

    Whether the apikey can view monitoring jobs.

    name str

    The free form name of the apikey.

    security_manage_active_directory bool

    Whether the apikey can manage global active directory. Only relevant for the DDI product.

    security_manage_global2fa bool

    Whether the apikey can manage global two factor authentication.

    teams Sequence[str]

    The teams that the apikey belongs to.

    accountManageAccountSettings Boolean

    Whether the apikey can modify account settings.

    accountManageApikeys Boolean

    Whether the apikey can modify account apikeys.

    accountManageIpWhitelist Boolean

    Whether the apikey can manage ip whitelist.

    accountManagePaymentMethods Boolean

    Whether the apikey can modify account payment methods.

    accountManagePlan Boolean

    No longer in use.

    Deprecated:

    obsolete, should no longer be used

    accountManageTeams Boolean

    Whether the apikey can modify other teams in the account.

    accountManageUsers Boolean

    Whether the apikey can modify account users.

    accountViewActivityLog Boolean

    Whether the apikey can view activity logs.

    accountViewInvoices Boolean

    Whether the apikey can view invoices.

    dataManageDatafeeds Boolean

    Whether the apikey can modify data feeds.

    dataManageDatasources Boolean

    Whether the apikey can modify data sources.

    dataPushToDatafeeds Boolean

    Whether the apikey can publish to data feeds.

    dhcpManageDhcp Boolean

    Whether the apikey can manage DHCP. Only relevant for the DDI product.

    dhcpViewDhcp Boolean

    Whether the apikey can view DHCP. Only relevant for the DDI product.

    dnsManageZones Boolean

    Whether the apikey can modify the accounts zones.

    dnsRecordsAllows List<Property Map>

    List of records that the apikey may access.

    dnsRecordsDenies List<Property Map>

    List of records that the apikey may not access.

    dnsViewZones Boolean

    Whether the apikey can view the accounts zones.

    dnsZonesAllowByDefault Boolean

    If true, enable the dns_zones_allow list, otherwise enable the dns_zones_deny list.

    dnsZonesAllows List<String>

    List of zones that the apikey may access.

    dnsZonesDenies List<String>

    List of zones that the apikey may not access.

    ipWhitelistStrict Boolean

    Set to true to restrict access to only those IP addresses and networks listed in the ip_whitelist field.

    ipWhitelists List<String>

    Array of IP addresses/networks to which to grant the API key access.

    ipamManageIpam Boolean

    Whether the apikey can manage IPAM. Only relevant for the DDI product.

    ipamViewIpam Boolean

    Whether the apikey can view IPAM. Only relevant for the DDI product.

    monitoringManageJobs Boolean

    Whether the apikey can modify monitoring jobs.

    monitoringManageLists Boolean

    Whether the apikey can modify notification lists.

    monitoringViewJobs Boolean

    Whether the apikey can view monitoring jobs.

    name String

    The free form name of the apikey.

    securityManageActiveDirectory Boolean

    Whether the apikey can manage global active directory. Only relevant for the DDI product.

    securityManageGlobal2fa Boolean

    Whether the apikey can manage global two factor authentication.

    teams List<String>

    The teams that the apikey belongs to.

    Outputs

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

    Id string

    The provider-assigned unique ID for this managed resource.

    Key string

    (Computed) The apikeys authentication token.

    Id string

    The provider-assigned unique ID for this managed resource.

    Key string

    (Computed) The apikeys authentication token.

    id String

    The provider-assigned unique ID for this managed resource.

    key String

    (Computed) The apikeys authentication token.

    id string

    The provider-assigned unique ID for this managed resource.

    key string

    (Computed) The apikeys authentication token.

    id str

    The provider-assigned unique ID for this managed resource.

    key str

    (Computed) The apikeys authentication token.

    id String

    The provider-assigned unique ID for this managed resource.

    key String

    (Computed) The apikeys authentication token.

    Look up Existing APIKey Resource

    Get an existing APIKey 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?: APIKeyState, opts?: CustomResourceOptions): APIKey
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            account_manage_account_settings: Optional[bool] = None,
            account_manage_apikeys: Optional[bool] = None,
            account_manage_ip_whitelist: Optional[bool] = None,
            account_manage_payment_methods: Optional[bool] = None,
            account_manage_plan: Optional[bool] = None,
            account_manage_teams: Optional[bool] = None,
            account_manage_users: Optional[bool] = None,
            account_view_activity_log: Optional[bool] = None,
            account_view_invoices: Optional[bool] = None,
            data_manage_datafeeds: Optional[bool] = None,
            data_manage_datasources: Optional[bool] = None,
            data_push_to_datafeeds: Optional[bool] = None,
            dhcp_manage_dhcp: Optional[bool] = None,
            dhcp_view_dhcp: Optional[bool] = None,
            dns_manage_zones: Optional[bool] = None,
            dns_records_allows: Optional[Sequence[APIKeyDnsRecordsAllowArgs]] = None,
            dns_records_denies: Optional[Sequence[APIKeyDnsRecordsDenyArgs]] = None,
            dns_view_zones: Optional[bool] = None,
            dns_zones_allow_by_default: Optional[bool] = None,
            dns_zones_allows: Optional[Sequence[str]] = None,
            dns_zones_denies: Optional[Sequence[str]] = None,
            ip_whitelist_strict: Optional[bool] = None,
            ip_whitelists: Optional[Sequence[str]] = None,
            ipam_manage_ipam: Optional[bool] = None,
            ipam_view_ipam: Optional[bool] = None,
            key: Optional[str] = None,
            monitoring_manage_jobs: Optional[bool] = None,
            monitoring_manage_lists: Optional[bool] = None,
            monitoring_view_jobs: Optional[bool] = None,
            name: Optional[str] = None,
            security_manage_active_directory: Optional[bool] = None,
            security_manage_global2fa: Optional[bool] = None,
            teams: Optional[Sequence[str]] = None) -> APIKey
    func GetAPIKey(ctx *Context, name string, id IDInput, state *APIKeyState, opts ...ResourceOption) (*APIKey, error)
    public static APIKey Get(string name, Input<string> id, APIKeyState? state, CustomResourceOptions? opts = null)
    public static APIKey get(String name, Output<String> id, APIKeyState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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:
    AccountManageAccountSettings bool

    Whether the apikey can modify account settings.

    AccountManageApikeys bool

    Whether the apikey can modify account apikeys.

    AccountManageIpWhitelist bool

    Whether the apikey can manage ip whitelist.

    AccountManagePaymentMethods bool

    Whether the apikey can modify account payment methods.

    AccountManagePlan bool

    No longer in use.

    Deprecated:

    obsolete, should no longer be used

    AccountManageTeams bool

    Whether the apikey can modify other teams in the account.

    AccountManageUsers bool

    Whether the apikey can modify account users.

    AccountViewActivityLog bool

    Whether the apikey can view activity logs.

    AccountViewInvoices bool

    Whether the apikey can view invoices.

    DataManageDatafeeds bool

    Whether the apikey can modify data feeds.

    DataManageDatasources bool

    Whether the apikey can modify data sources.

    DataPushToDatafeeds bool

    Whether the apikey can publish to data feeds.

    DhcpManageDhcp bool

    Whether the apikey can manage DHCP. Only relevant for the DDI product.

    DhcpViewDhcp bool

    Whether the apikey can view DHCP. Only relevant for the DDI product.

    DnsManageZones bool

    Whether the apikey can modify the accounts zones.

    DnsRecordsAllows List<APIKeyDnsRecordsAllow>

    List of records that the apikey may access.

    DnsRecordsDenies List<APIKeyDnsRecordsDeny>

    List of records that the apikey may not access.

    DnsViewZones bool

    Whether the apikey can view the accounts zones.

    DnsZonesAllowByDefault bool

    If true, enable the dns_zones_allow list, otherwise enable the dns_zones_deny list.

    DnsZonesAllows List<string>

    List of zones that the apikey may access.

    DnsZonesDenies List<string>

    List of zones that the apikey may not access.

    IpWhitelistStrict bool

    Set to true to restrict access to only those IP addresses and networks listed in the ip_whitelist field.

    IpWhitelists List<string>

    Array of IP addresses/networks to which to grant the API key access.

    IpamManageIpam bool

    Whether the apikey can manage IPAM. Only relevant for the DDI product.

    IpamViewIpam bool

    Whether the apikey can view IPAM. Only relevant for the DDI product.

    Key string

    (Computed) The apikeys authentication token.

    MonitoringManageJobs bool

    Whether the apikey can modify monitoring jobs.

    MonitoringManageLists bool

    Whether the apikey can modify notification lists.

    MonitoringViewJobs bool

    Whether the apikey can view monitoring jobs.

    Name string

    The free form name of the apikey.

    SecurityManageActiveDirectory bool

    Whether the apikey can manage global active directory. Only relevant for the DDI product.

    SecurityManageGlobal2fa bool

    Whether the apikey can manage global two factor authentication.

    Teams List<string>

    The teams that the apikey belongs to.

    AccountManageAccountSettings bool

    Whether the apikey can modify account settings.

    AccountManageApikeys bool

    Whether the apikey can modify account apikeys.

    AccountManageIpWhitelist bool

    Whether the apikey can manage ip whitelist.

    AccountManagePaymentMethods bool

    Whether the apikey can modify account payment methods.

    AccountManagePlan bool

    No longer in use.

    Deprecated:

    obsolete, should no longer be used

    AccountManageTeams bool

    Whether the apikey can modify other teams in the account.

    AccountManageUsers bool

    Whether the apikey can modify account users.

    AccountViewActivityLog bool

    Whether the apikey can view activity logs.

    AccountViewInvoices bool

    Whether the apikey can view invoices.

    DataManageDatafeeds bool

    Whether the apikey can modify data feeds.

    DataManageDatasources bool

    Whether the apikey can modify data sources.

    DataPushToDatafeeds bool

    Whether the apikey can publish to data feeds.

    DhcpManageDhcp bool

    Whether the apikey can manage DHCP. Only relevant for the DDI product.

    DhcpViewDhcp bool

    Whether the apikey can view DHCP. Only relevant for the DDI product.

    DnsManageZones bool

    Whether the apikey can modify the accounts zones.

    DnsRecordsAllows []APIKeyDnsRecordsAllowArgs

    List of records that the apikey may access.

    DnsRecordsDenies []APIKeyDnsRecordsDenyArgs

    List of records that the apikey may not access.

    DnsViewZones bool

    Whether the apikey can view the accounts zones.

    DnsZonesAllowByDefault bool

    If true, enable the dns_zones_allow list, otherwise enable the dns_zones_deny list.

    DnsZonesAllows []string

    List of zones that the apikey may access.

    DnsZonesDenies []string

    List of zones that the apikey may not access.

    IpWhitelistStrict bool

    Set to true to restrict access to only those IP addresses and networks listed in the ip_whitelist field.

    IpWhitelists []string

    Array of IP addresses/networks to which to grant the API key access.

    IpamManageIpam bool

    Whether the apikey can manage IPAM. Only relevant for the DDI product.

    IpamViewIpam bool

    Whether the apikey can view IPAM. Only relevant for the DDI product.

    Key string

    (Computed) The apikeys authentication token.

    MonitoringManageJobs bool

    Whether the apikey can modify monitoring jobs.

    MonitoringManageLists bool

    Whether the apikey can modify notification lists.

    MonitoringViewJobs bool

    Whether the apikey can view monitoring jobs.

    Name string

    The free form name of the apikey.

    SecurityManageActiveDirectory bool

    Whether the apikey can manage global active directory. Only relevant for the DDI product.

    SecurityManageGlobal2fa bool

    Whether the apikey can manage global two factor authentication.

    Teams []string

    The teams that the apikey belongs to.

    accountManageAccountSettings Boolean

    Whether the apikey can modify account settings.

    accountManageApikeys Boolean

    Whether the apikey can modify account apikeys.

    accountManageIpWhitelist Boolean

    Whether the apikey can manage ip whitelist.

    accountManagePaymentMethods Boolean

    Whether the apikey can modify account payment methods.

    accountManagePlan Boolean

    No longer in use.

    Deprecated:

    obsolete, should no longer be used

    accountManageTeams Boolean

    Whether the apikey can modify other teams in the account.

    accountManageUsers Boolean

    Whether the apikey can modify account users.

    accountViewActivityLog Boolean

    Whether the apikey can view activity logs.

    accountViewInvoices Boolean

    Whether the apikey can view invoices.

    dataManageDatafeeds Boolean

    Whether the apikey can modify data feeds.

    dataManageDatasources Boolean

    Whether the apikey can modify data sources.

    dataPushToDatafeeds Boolean

    Whether the apikey can publish to data feeds.

    dhcpManageDhcp Boolean

    Whether the apikey can manage DHCP. Only relevant for the DDI product.

    dhcpViewDhcp Boolean

    Whether the apikey can view DHCP. Only relevant for the DDI product.

    dnsManageZones Boolean

    Whether the apikey can modify the accounts zones.

    dnsRecordsAllows List<APIKeyDnsRecordsAllow>

    List of records that the apikey may access.

    dnsRecordsDenies List<APIKeyDnsRecordsDeny>

    List of records that the apikey may not access.

    dnsViewZones Boolean

    Whether the apikey can view the accounts zones.

    dnsZonesAllowByDefault Boolean

    If true, enable the dns_zones_allow list, otherwise enable the dns_zones_deny list.

    dnsZonesAllows List<String>

    List of zones that the apikey may access.

    dnsZonesDenies List<String>

    List of zones that the apikey may not access.

    ipWhitelistStrict Boolean

    Set to true to restrict access to only those IP addresses and networks listed in the ip_whitelist field.

    ipWhitelists List<String>

    Array of IP addresses/networks to which to grant the API key access.

    ipamManageIpam Boolean

    Whether the apikey can manage IPAM. Only relevant for the DDI product.

    ipamViewIpam Boolean

    Whether the apikey can view IPAM. Only relevant for the DDI product.

    key String

    (Computed) The apikeys authentication token.

    monitoringManageJobs Boolean

    Whether the apikey can modify monitoring jobs.

    monitoringManageLists Boolean

    Whether the apikey can modify notification lists.

    monitoringViewJobs Boolean

    Whether the apikey can view monitoring jobs.

    name String

    The free form name of the apikey.

    securityManageActiveDirectory Boolean

    Whether the apikey can manage global active directory. Only relevant for the DDI product.

    securityManageGlobal2fa Boolean

    Whether the apikey can manage global two factor authentication.

    teams List<String>

    The teams that the apikey belongs to.

    accountManageAccountSettings boolean

    Whether the apikey can modify account settings.

    accountManageApikeys boolean

    Whether the apikey can modify account apikeys.

    accountManageIpWhitelist boolean

    Whether the apikey can manage ip whitelist.

    accountManagePaymentMethods boolean

    Whether the apikey can modify account payment methods.

    accountManagePlan boolean

    No longer in use.

    Deprecated:

    obsolete, should no longer be used

    accountManageTeams boolean

    Whether the apikey can modify other teams in the account.

    accountManageUsers boolean

    Whether the apikey can modify account users.

    accountViewActivityLog boolean

    Whether the apikey can view activity logs.

    accountViewInvoices boolean

    Whether the apikey can view invoices.

    dataManageDatafeeds boolean

    Whether the apikey can modify data feeds.

    dataManageDatasources boolean

    Whether the apikey can modify data sources.

    dataPushToDatafeeds boolean

    Whether the apikey can publish to data feeds.

    dhcpManageDhcp boolean

    Whether the apikey can manage DHCP. Only relevant for the DDI product.

    dhcpViewDhcp boolean

    Whether the apikey can view DHCP. Only relevant for the DDI product.

    dnsManageZones boolean

    Whether the apikey can modify the accounts zones.

    dnsRecordsAllows APIKeyDnsRecordsAllow[]

    List of records that the apikey may access.

    dnsRecordsDenies APIKeyDnsRecordsDeny[]

    List of records that the apikey may not access.

    dnsViewZones boolean

    Whether the apikey can view the accounts zones.

    dnsZonesAllowByDefault boolean

    If true, enable the dns_zones_allow list, otherwise enable the dns_zones_deny list.

    dnsZonesAllows string[]

    List of zones that the apikey may access.

    dnsZonesDenies string[]

    List of zones that the apikey may not access.

    ipWhitelistStrict boolean

    Set to true to restrict access to only those IP addresses and networks listed in the ip_whitelist field.

    ipWhitelists string[]

    Array of IP addresses/networks to which to grant the API key access.

    ipamManageIpam boolean

    Whether the apikey can manage IPAM. Only relevant for the DDI product.

    ipamViewIpam boolean

    Whether the apikey can view IPAM. Only relevant for the DDI product.

    key string

    (Computed) The apikeys authentication token.

    monitoringManageJobs boolean

    Whether the apikey can modify monitoring jobs.

    monitoringManageLists boolean

    Whether the apikey can modify notification lists.

    monitoringViewJobs boolean

    Whether the apikey can view monitoring jobs.

    name string

    The free form name of the apikey.

    securityManageActiveDirectory boolean

    Whether the apikey can manage global active directory. Only relevant for the DDI product.

    securityManageGlobal2fa boolean

    Whether the apikey can manage global two factor authentication.

    teams string[]

    The teams that the apikey belongs to.

    account_manage_account_settings bool

    Whether the apikey can modify account settings.

    account_manage_apikeys bool

    Whether the apikey can modify account apikeys.

    account_manage_ip_whitelist bool

    Whether the apikey can manage ip whitelist.

    account_manage_payment_methods bool

    Whether the apikey can modify account payment methods.

    account_manage_plan bool

    No longer in use.

    Deprecated:

    obsolete, should no longer be used

    account_manage_teams bool

    Whether the apikey can modify other teams in the account.

    account_manage_users bool

    Whether the apikey can modify account users.

    account_view_activity_log bool

    Whether the apikey can view activity logs.

    account_view_invoices bool

    Whether the apikey can view invoices.

    data_manage_datafeeds bool

    Whether the apikey can modify data feeds.

    data_manage_datasources bool

    Whether the apikey can modify data sources.

    data_push_to_datafeeds bool

    Whether the apikey can publish to data feeds.

    dhcp_manage_dhcp bool

    Whether the apikey can manage DHCP. Only relevant for the DDI product.

    dhcp_view_dhcp bool

    Whether the apikey can view DHCP. Only relevant for the DDI product.

    dns_manage_zones bool

    Whether the apikey can modify the accounts zones.

    dns_records_allows Sequence[APIKeyDnsRecordsAllowArgs]

    List of records that the apikey may access.

    dns_records_denies Sequence[APIKeyDnsRecordsDenyArgs]

    List of records that the apikey may not access.

    dns_view_zones bool

    Whether the apikey can view the accounts zones.

    dns_zones_allow_by_default bool

    If true, enable the dns_zones_allow list, otherwise enable the dns_zones_deny list.

    dns_zones_allows Sequence[str]

    List of zones that the apikey may access.

    dns_zones_denies Sequence[str]

    List of zones that the apikey may not access.

    ip_whitelist_strict bool

    Set to true to restrict access to only those IP addresses and networks listed in the ip_whitelist field.

    ip_whitelists Sequence[str]

    Array of IP addresses/networks to which to grant the API key access.

    ipam_manage_ipam bool

    Whether the apikey can manage IPAM. Only relevant for the DDI product.

    ipam_view_ipam bool

    Whether the apikey can view IPAM. Only relevant for the DDI product.

    key str

    (Computed) The apikeys authentication token.

    monitoring_manage_jobs bool

    Whether the apikey can modify monitoring jobs.

    monitoring_manage_lists bool

    Whether the apikey can modify notification lists.

    monitoring_view_jobs bool

    Whether the apikey can view monitoring jobs.

    name str

    The free form name of the apikey.

    security_manage_active_directory bool

    Whether the apikey can manage global active directory. Only relevant for the DDI product.

    security_manage_global2fa bool

    Whether the apikey can manage global two factor authentication.

    teams Sequence[str]

    The teams that the apikey belongs to.

    accountManageAccountSettings Boolean

    Whether the apikey can modify account settings.

    accountManageApikeys Boolean

    Whether the apikey can modify account apikeys.

    accountManageIpWhitelist Boolean

    Whether the apikey can manage ip whitelist.

    accountManagePaymentMethods Boolean

    Whether the apikey can modify account payment methods.

    accountManagePlan Boolean

    No longer in use.

    Deprecated:

    obsolete, should no longer be used

    accountManageTeams Boolean

    Whether the apikey can modify other teams in the account.

    accountManageUsers Boolean

    Whether the apikey can modify account users.

    accountViewActivityLog Boolean

    Whether the apikey can view activity logs.

    accountViewInvoices Boolean

    Whether the apikey can view invoices.

    dataManageDatafeeds Boolean

    Whether the apikey can modify data feeds.

    dataManageDatasources Boolean

    Whether the apikey can modify data sources.

    dataPushToDatafeeds Boolean

    Whether the apikey can publish to data feeds.

    dhcpManageDhcp Boolean

    Whether the apikey can manage DHCP. Only relevant for the DDI product.

    dhcpViewDhcp Boolean

    Whether the apikey can view DHCP. Only relevant for the DDI product.

    dnsManageZones Boolean

    Whether the apikey can modify the accounts zones.

    dnsRecordsAllows List<Property Map>

    List of records that the apikey may access.

    dnsRecordsDenies List<Property Map>

    List of records that the apikey may not access.

    dnsViewZones Boolean

    Whether the apikey can view the accounts zones.

    dnsZonesAllowByDefault Boolean

    If true, enable the dns_zones_allow list, otherwise enable the dns_zones_deny list.

    dnsZonesAllows List<String>

    List of zones that the apikey may access.

    dnsZonesDenies List<String>

    List of zones that the apikey may not access.

    ipWhitelistStrict Boolean

    Set to true to restrict access to only those IP addresses and networks listed in the ip_whitelist field.

    ipWhitelists List<String>

    Array of IP addresses/networks to which to grant the API key access.

    ipamManageIpam Boolean

    Whether the apikey can manage IPAM. Only relevant for the DDI product.

    ipamViewIpam Boolean

    Whether the apikey can view IPAM. Only relevant for the DDI product.

    key String

    (Computed) The apikeys authentication token.

    monitoringManageJobs Boolean

    Whether the apikey can modify monitoring jobs.

    monitoringManageLists Boolean

    Whether the apikey can modify notification lists.

    monitoringViewJobs Boolean

    Whether the apikey can view monitoring jobs.

    name String

    The free form name of the apikey.

    securityManageActiveDirectory Boolean

    Whether the apikey can manage global active directory. Only relevant for the DDI product.

    securityManageGlobal2fa Boolean

    Whether the apikey can manage global two factor authentication.

    teams List<String>

    The teams that the apikey belongs to.

    Supporting Types

    APIKeyDnsRecordsAllow, APIKeyDnsRecordsAllowArgs

    Domain string
    IncludeSubdomains bool
    Type string
    Zone string
    Domain string
    IncludeSubdomains bool
    Type string
    Zone string
    domain String
    includeSubdomains Boolean
    type String
    zone String
    domain string
    includeSubdomains boolean
    type string
    zone string
    domain String
    includeSubdomains Boolean
    type String
    zone String

    APIKeyDnsRecordsDeny, APIKeyDnsRecordsDenyArgs

    Domain string
    IncludeSubdomains bool
    Type string
    Zone string
    Domain string
    IncludeSubdomains bool
    Type string
    Zone string
    domain String
    includeSubdomains Boolean
    type String
    zone String
    domain string
    includeSubdomains boolean
    type string
    zone string
    domain String
    includeSubdomains Boolean
    type String
    zone String

    Import

     $ pulumi import ns1:index/aPIKey:APIKey `ns1_apikey`
    

    So for the example above

     $ pulumi import ns1:index/aPIKey:APIKey example <ID>`
    

    Package Details

    Repository
    NS1 pulumi/pulumi-ns1
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the ns1 Terraform Provider.

    ns1 logo
    NS1 v3.1.0 published on Tuesday, Sep 19, 2023 by Pulumi