1. Packages
  2. Packages
  3. Rootly
  4. API Docs
  5. OnCallRole
Viewing docs for Rootly v3.3.0
published on Thursday, May 7, 2026 by rootlyhq
rootly logo
Viewing docs for Rootly v3.3.0
published on Thursday, May 7, 2026 by rootlyhq

    Example Usage

    resource "rootly_on_call_role" "custom" {
      name = "Custom On-Call Role"
    
      alerts_permissions = [
        "create",
        "update",
        "read",
      ]
      escalation_policies_permissions = [
        "create",
        "read",
        "update",
        "delete",
      ]
      schedules_permissions = [
        "read",
        "update",
      ]
      schedule_override_permissions = [
        "create",
        "update",
      ]
    }
    

    Create OnCallRole Resource

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

    Constructor syntax

    new OnCallRole(name: string, args?: OnCallRoleArgs, opts?: CustomResourceOptions);
    @overload
    def OnCallRole(resource_name: str,
                   args: Optional[OnCallRoleArgs] = None,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def OnCallRole(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   alert_fields_permissions: Optional[Sequence[str]] = None,
                   alert_groups_permissions: Optional[Sequence[str]] = None,
                   alert_routing_rules_permissions: Optional[Sequence[str]] = None,
                   alert_sources_permissions: Optional[Sequence[str]] = None,
                   alert_urgency_permissions: Optional[Sequence[str]] = None,
                   alerts_permissions: Optional[Sequence[str]] = None,
                   api_keys_permissions: Optional[Sequence[str]] = None,
                   audits_permissions: Optional[Sequence[str]] = None,
                   contacts_permissions: Optional[Sequence[str]] = None,
                   escalation_policies_permissions: Optional[Sequence[str]] = None,
                   groups_permissions: Optional[Sequence[str]] = None,
                   heartbeats_permissions: Optional[Sequence[str]] = None,
                   integrations_permissions: Optional[Sequence[str]] = None,
                   invitations_permissions: Optional[Sequence[str]] = None,
                   live_call_routing_permissions: Optional[Sequence[str]] = None,
                   name: Optional[str] = None,
                   on_call_readiness_report_permissions: Optional[Sequence[str]] = None,
                   on_call_roles_permissions: Optional[Sequence[str]] = None,
                   schedule_override_permissions: Optional[Sequence[str]] = None,
                   schedules_permissions: Optional[Sequence[str]] = None,
                   services_permissions: Optional[Sequence[str]] = None,
                   slug: Optional[str] = None,
                   system_role: Optional[str] = None,
                   webhooks_permissions: Optional[Sequence[str]] = None,
                   workflows_permissions: Optional[Sequence[str]] = None)
    func NewOnCallRole(ctx *Context, name string, args *OnCallRoleArgs, opts ...ResourceOption) (*OnCallRole, error)
    public OnCallRole(string name, OnCallRoleArgs? args = null, CustomResourceOptions? opts = null)
    public OnCallRole(String name, OnCallRoleArgs args)
    public OnCallRole(String name, OnCallRoleArgs args, CustomResourceOptions options)
    
    type: rootly:OnCallRole
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args OnCallRoleArgs
    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 OnCallRoleArgs
    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 OnCallRoleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args OnCallRoleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args OnCallRoleArgs
    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 onCallRoleResource = new Rootly.OnCallRole("onCallRoleResource", new()
    {
        AlertFieldsPermissions = new[]
        {
            "string",
        },
        AlertGroupsPermissions = new[]
        {
            "string",
        },
        AlertRoutingRulesPermissions = new[]
        {
            "string",
        },
        AlertSourcesPermissions = new[]
        {
            "string",
        },
        AlertUrgencyPermissions = new[]
        {
            "string",
        },
        AlertsPermissions = new[]
        {
            "string",
        },
        ApiKeysPermissions = new[]
        {
            "string",
        },
        AuditsPermissions = new[]
        {
            "string",
        },
        ContactsPermissions = new[]
        {
            "string",
        },
        EscalationPoliciesPermissions = new[]
        {
            "string",
        },
        GroupsPermissions = new[]
        {
            "string",
        },
        HeartbeatsPermissions = new[]
        {
            "string",
        },
        IntegrationsPermissions = new[]
        {
            "string",
        },
        InvitationsPermissions = new[]
        {
            "string",
        },
        LiveCallRoutingPermissions = new[]
        {
            "string",
        },
        Name = "string",
        OnCallReadinessReportPermissions = new[]
        {
            "string",
        },
        OnCallRolesPermissions = new[]
        {
            "string",
        },
        ScheduleOverridePermissions = new[]
        {
            "string",
        },
        SchedulesPermissions = new[]
        {
            "string",
        },
        ServicesPermissions = new[]
        {
            "string",
        },
        Slug = "string",
        SystemRole = "string",
        WebhooksPermissions = new[]
        {
            "string",
        },
        WorkflowsPermissions = new[]
        {
            "string",
        },
    });
    
    example, err := rootly.NewOnCallRole(ctx, "onCallRoleResource", &rootly.OnCallRoleArgs{
    	AlertFieldsPermissions: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	AlertGroupsPermissions: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	AlertRoutingRulesPermissions: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	AlertSourcesPermissions: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	AlertUrgencyPermissions: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	AlertsPermissions: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	ApiKeysPermissions: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	AuditsPermissions: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	ContactsPermissions: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	EscalationPoliciesPermissions: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	GroupsPermissions: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	HeartbeatsPermissions: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	IntegrationsPermissions: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	InvitationsPermissions: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	LiveCallRoutingPermissions: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Name: pulumi.String("string"),
    	OnCallReadinessReportPermissions: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	OnCallRolesPermissions: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	ScheduleOverridePermissions: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	SchedulesPermissions: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	ServicesPermissions: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Slug:       pulumi.String("string"),
    	SystemRole: pulumi.String("string"),
    	WebhooksPermissions: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	WorkflowsPermissions: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    })
    
    var onCallRoleResource = new OnCallRole("onCallRoleResource", OnCallRoleArgs.builder()
        .alertFieldsPermissions("string")
        .alertGroupsPermissions("string")
        .alertRoutingRulesPermissions("string")
        .alertSourcesPermissions("string")
        .alertUrgencyPermissions("string")
        .alertsPermissions("string")
        .apiKeysPermissions("string")
        .auditsPermissions("string")
        .contactsPermissions("string")
        .escalationPoliciesPermissions("string")
        .groupsPermissions("string")
        .heartbeatsPermissions("string")
        .integrationsPermissions("string")
        .invitationsPermissions("string")
        .liveCallRoutingPermissions("string")
        .name("string")
        .onCallReadinessReportPermissions("string")
        .onCallRolesPermissions("string")
        .scheduleOverridePermissions("string")
        .schedulesPermissions("string")
        .servicesPermissions("string")
        .slug("string")
        .systemRole("string")
        .webhooksPermissions("string")
        .workflowsPermissions("string")
        .build());
    
    on_call_role_resource = rootly.OnCallRole("onCallRoleResource",
        alert_fields_permissions=["string"],
        alert_groups_permissions=["string"],
        alert_routing_rules_permissions=["string"],
        alert_sources_permissions=["string"],
        alert_urgency_permissions=["string"],
        alerts_permissions=["string"],
        api_keys_permissions=["string"],
        audits_permissions=["string"],
        contacts_permissions=["string"],
        escalation_policies_permissions=["string"],
        groups_permissions=["string"],
        heartbeats_permissions=["string"],
        integrations_permissions=["string"],
        invitations_permissions=["string"],
        live_call_routing_permissions=["string"],
        name="string",
        on_call_readiness_report_permissions=["string"],
        on_call_roles_permissions=["string"],
        schedule_override_permissions=["string"],
        schedules_permissions=["string"],
        services_permissions=["string"],
        slug="string",
        system_role="string",
        webhooks_permissions=["string"],
        workflows_permissions=["string"])
    
    const onCallRoleResource = new rootly.OnCallRole("onCallRoleResource", {
        alertFieldsPermissions: ["string"],
        alertGroupsPermissions: ["string"],
        alertRoutingRulesPermissions: ["string"],
        alertSourcesPermissions: ["string"],
        alertUrgencyPermissions: ["string"],
        alertsPermissions: ["string"],
        apiKeysPermissions: ["string"],
        auditsPermissions: ["string"],
        contactsPermissions: ["string"],
        escalationPoliciesPermissions: ["string"],
        groupsPermissions: ["string"],
        heartbeatsPermissions: ["string"],
        integrationsPermissions: ["string"],
        invitationsPermissions: ["string"],
        liveCallRoutingPermissions: ["string"],
        name: "string",
        onCallReadinessReportPermissions: ["string"],
        onCallRolesPermissions: ["string"],
        scheduleOverridePermissions: ["string"],
        schedulesPermissions: ["string"],
        servicesPermissions: ["string"],
        slug: "string",
        systemRole: "string",
        webhooksPermissions: ["string"],
        workflowsPermissions: ["string"],
    });
    
    type: rootly:OnCallRole
    properties:
        alertFieldsPermissions:
            - string
        alertGroupsPermissions:
            - string
        alertRoutingRulesPermissions:
            - string
        alertSourcesPermissions:
            - string
        alertUrgencyPermissions:
            - string
        alertsPermissions:
            - string
        apiKeysPermissions:
            - string
        auditsPermissions:
            - string
        contactsPermissions:
            - string
        escalationPoliciesPermissions:
            - string
        groupsPermissions:
            - string
        heartbeatsPermissions:
            - string
        integrationsPermissions:
            - string
        invitationsPermissions:
            - string
        liveCallRoutingPermissions:
            - string
        name: string
        onCallReadinessReportPermissions:
            - string
        onCallRolesPermissions:
            - string
        scheduleOverridePermissions:
            - string
        schedulesPermissions:
            - string
        servicesPermissions:
            - string
        slug: string
        systemRole: string
        webhooksPermissions:
            - string
        workflowsPermissions:
            - string
    

    OnCallRole 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 OnCallRole resource accepts the following input properties:

    AlertFieldsPermissions List<string>
    Value must be one of create, read, update, delete.
    AlertGroupsPermissions List<string>
    Value must be one of create, read, update, delete.
    AlertRoutingRulesPermissions List<string>
    Value must be one of create, read, update, delete.
    AlertSourcesPermissions List<string>
    Value must be one of create, read, update, delete.
    AlertUrgencyPermissions List<string>
    Value must be one of create, read, update, delete.
    AlertsPermissions List<string>
    Value must be one of create, update, read, delete.
    ApiKeysPermissions List<string>
    Value must be one of create, read, update, delete.
    AuditsPermissions List<string>
    Value must be one of create, read, update, delete.
    ContactsPermissions List<string>
    Value must be one of read.
    EscalationPoliciesPermissions List<string>
    Value must be one of create, read, update, delete.
    GroupsPermissions List<string>
    Value must be one of create, read, update, delete.
    HeartbeatsPermissions List<string>
    Value must be one of create, read, update, delete.
    IntegrationsPermissions List<string>
    Value must be one of create, read, update, delete.
    InvitationsPermissions List<string>
    Value must be one of create, read, update, delete.
    LiveCallRoutingPermissions List<string>
    Value must be one of create, read, update, delete.
    Name string
    The role name.
    OnCallReadinessReportPermissions List<string>
    Value must be one of create, read, update, delete.
    OnCallRolesPermissions List<string>
    Value must be one of create, read, update, delete.
    ScheduleOverridePermissions List<string>
    Value must be one of create, update.
    SchedulesPermissions List<string>
    Value must be one of create, read, update, delete.
    ServicesPermissions List<string>
    Value must be one of create, read, update, delete.
    Slug string
    The role slug.
    SystemRole string
    The kind of role
    WebhooksPermissions List<string>
    Value must be one of create, read, update, delete.
    WorkflowsPermissions List<string>
    Value must be one of create, read, update, delete.
    AlertFieldsPermissions []string
    Value must be one of create, read, update, delete.
    AlertGroupsPermissions []string
    Value must be one of create, read, update, delete.
    AlertRoutingRulesPermissions []string
    Value must be one of create, read, update, delete.
    AlertSourcesPermissions []string
    Value must be one of create, read, update, delete.
    AlertUrgencyPermissions []string
    Value must be one of create, read, update, delete.
    AlertsPermissions []string
    Value must be one of create, update, read, delete.
    ApiKeysPermissions []string
    Value must be one of create, read, update, delete.
    AuditsPermissions []string
    Value must be one of create, read, update, delete.
    ContactsPermissions []string
    Value must be one of read.
    EscalationPoliciesPermissions []string
    Value must be one of create, read, update, delete.
    GroupsPermissions []string
    Value must be one of create, read, update, delete.
    HeartbeatsPermissions []string
    Value must be one of create, read, update, delete.
    IntegrationsPermissions []string
    Value must be one of create, read, update, delete.
    InvitationsPermissions []string
    Value must be one of create, read, update, delete.
    LiveCallRoutingPermissions []string
    Value must be one of create, read, update, delete.
    Name string
    The role name.
    OnCallReadinessReportPermissions []string
    Value must be one of create, read, update, delete.
    OnCallRolesPermissions []string
    Value must be one of create, read, update, delete.
    ScheduleOverridePermissions []string
    Value must be one of create, update.
    SchedulesPermissions []string
    Value must be one of create, read, update, delete.
    ServicesPermissions []string
    Value must be one of create, read, update, delete.
    Slug string
    The role slug.
    SystemRole string
    The kind of role
    WebhooksPermissions []string
    Value must be one of create, read, update, delete.
    WorkflowsPermissions []string
    Value must be one of create, read, update, delete.
    alertFieldsPermissions List<String>
    Value must be one of create, read, update, delete.
    alertGroupsPermissions List<String>
    Value must be one of create, read, update, delete.
    alertRoutingRulesPermissions List<String>
    Value must be one of create, read, update, delete.
    alertSourcesPermissions List<String>
    Value must be one of create, read, update, delete.
    alertUrgencyPermissions List<String>
    Value must be one of create, read, update, delete.
    alertsPermissions List<String>
    Value must be one of create, update, read, delete.
    apiKeysPermissions List<String>
    Value must be one of create, read, update, delete.
    auditsPermissions List<String>
    Value must be one of create, read, update, delete.
    contactsPermissions List<String>
    Value must be one of read.
    escalationPoliciesPermissions List<String>
    Value must be one of create, read, update, delete.
    groupsPermissions List<String>
    Value must be one of create, read, update, delete.
    heartbeatsPermissions List<String>
    Value must be one of create, read, update, delete.
    integrationsPermissions List<String>
    Value must be one of create, read, update, delete.
    invitationsPermissions List<String>
    Value must be one of create, read, update, delete.
    liveCallRoutingPermissions List<String>
    Value must be one of create, read, update, delete.
    name String
    The role name.
    onCallReadinessReportPermissions List<String>
    Value must be one of create, read, update, delete.
    onCallRolesPermissions List<String>
    Value must be one of create, read, update, delete.
    scheduleOverridePermissions List<String>
    Value must be one of create, update.
    schedulesPermissions List<String>
    Value must be one of create, read, update, delete.
    servicesPermissions List<String>
    Value must be one of create, read, update, delete.
    slug String
    The role slug.
    systemRole String
    The kind of role
    webhooksPermissions List<String>
    Value must be one of create, read, update, delete.
    workflowsPermissions List<String>
    Value must be one of create, read, update, delete.
    alertFieldsPermissions string[]
    Value must be one of create, read, update, delete.
    alertGroupsPermissions string[]
    Value must be one of create, read, update, delete.
    alertRoutingRulesPermissions string[]
    Value must be one of create, read, update, delete.
    alertSourcesPermissions string[]
    Value must be one of create, read, update, delete.
    alertUrgencyPermissions string[]
    Value must be one of create, read, update, delete.
    alertsPermissions string[]
    Value must be one of create, update, read, delete.
    apiKeysPermissions string[]
    Value must be one of create, read, update, delete.
    auditsPermissions string[]
    Value must be one of create, read, update, delete.
    contactsPermissions string[]
    Value must be one of read.
    escalationPoliciesPermissions string[]
    Value must be one of create, read, update, delete.
    groupsPermissions string[]
    Value must be one of create, read, update, delete.
    heartbeatsPermissions string[]
    Value must be one of create, read, update, delete.
    integrationsPermissions string[]
    Value must be one of create, read, update, delete.
    invitationsPermissions string[]
    Value must be one of create, read, update, delete.
    liveCallRoutingPermissions string[]
    Value must be one of create, read, update, delete.
    name string
    The role name.
    onCallReadinessReportPermissions string[]
    Value must be one of create, read, update, delete.
    onCallRolesPermissions string[]
    Value must be one of create, read, update, delete.
    scheduleOverridePermissions string[]
    Value must be one of create, update.
    schedulesPermissions string[]
    Value must be one of create, read, update, delete.
    servicesPermissions string[]
    Value must be one of create, read, update, delete.
    slug string
    The role slug.
    systemRole string
    The kind of role
    webhooksPermissions string[]
    Value must be one of create, read, update, delete.
    workflowsPermissions string[]
    Value must be one of create, read, update, delete.
    alert_fields_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    alert_groups_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    alert_routing_rules_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    alert_sources_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    alert_urgency_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    alerts_permissions Sequence[str]
    Value must be one of create, update, read, delete.
    api_keys_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    audits_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    contacts_permissions Sequence[str]
    Value must be one of read.
    escalation_policies_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    groups_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    heartbeats_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    integrations_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    invitations_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    live_call_routing_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    name str
    The role name.
    on_call_readiness_report_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    on_call_roles_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    schedule_override_permissions Sequence[str]
    Value must be one of create, update.
    schedules_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    services_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    slug str
    The role slug.
    system_role str
    The kind of role
    webhooks_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    workflows_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    alertFieldsPermissions List<String>
    Value must be one of create, read, update, delete.
    alertGroupsPermissions List<String>
    Value must be one of create, read, update, delete.
    alertRoutingRulesPermissions List<String>
    Value must be one of create, read, update, delete.
    alertSourcesPermissions List<String>
    Value must be one of create, read, update, delete.
    alertUrgencyPermissions List<String>
    Value must be one of create, read, update, delete.
    alertsPermissions List<String>
    Value must be one of create, update, read, delete.
    apiKeysPermissions List<String>
    Value must be one of create, read, update, delete.
    auditsPermissions List<String>
    Value must be one of create, read, update, delete.
    contactsPermissions List<String>
    Value must be one of read.
    escalationPoliciesPermissions List<String>
    Value must be one of create, read, update, delete.
    groupsPermissions List<String>
    Value must be one of create, read, update, delete.
    heartbeatsPermissions List<String>
    Value must be one of create, read, update, delete.
    integrationsPermissions List<String>
    Value must be one of create, read, update, delete.
    invitationsPermissions List<String>
    Value must be one of create, read, update, delete.
    liveCallRoutingPermissions List<String>
    Value must be one of create, read, update, delete.
    name String
    The role name.
    onCallReadinessReportPermissions List<String>
    Value must be one of create, read, update, delete.
    onCallRolesPermissions List<String>
    Value must be one of create, read, update, delete.
    scheduleOverridePermissions List<String>
    Value must be one of create, update.
    schedulesPermissions List<String>
    Value must be one of create, read, update, delete.
    servicesPermissions List<String>
    Value must be one of create, read, update, delete.
    slug String
    The role slug.
    systemRole String
    The kind of role
    webhooksPermissions List<String>
    Value must be one of create, read, update, delete.
    workflowsPermissions List<String>
    Value must be one of create, read, update, delete.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing OnCallRole Resource

    Get an existing OnCallRole 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?: OnCallRoleState, opts?: CustomResourceOptions): OnCallRole
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            alert_fields_permissions: Optional[Sequence[str]] = None,
            alert_groups_permissions: Optional[Sequence[str]] = None,
            alert_routing_rules_permissions: Optional[Sequence[str]] = None,
            alert_sources_permissions: Optional[Sequence[str]] = None,
            alert_urgency_permissions: Optional[Sequence[str]] = None,
            alerts_permissions: Optional[Sequence[str]] = None,
            api_keys_permissions: Optional[Sequence[str]] = None,
            audits_permissions: Optional[Sequence[str]] = None,
            contacts_permissions: Optional[Sequence[str]] = None,
            escalation_policies_permissions: Optional[Sequence[str]] = None,
            groups_permissions: Optional[Sequence[str]] = None,
            heartbeats_permissions: Optional[Sequence[str]] = None,
            integrations_permissions: Optional[Sequence[str]] = None,
            invitations_permissions: Optional[Sequence[str]] = None,
            live_call_routing_permissions: Optional[Sequence[str]] = None,
            name: Optional[str] = None,
            on_call_readiness_report_permissions: Optional[Sequence[str]] = None,
            on_call_roles_permissions: Optional[Sequence[str]] = None,
            schedule_override_permissions: Optional[Sequence[str]] = None,
            schedules_permissions: Optional[Sequence[str]] = None,
            services_permissions: Optional[Sequence[str]] = None,
            slug: Optional[str] = None,
            system_role: Optional[str] = None,
            webhooks_permissions: Optional[Sequence[str]] = None,
            workflows_permissions: Optional[Sequence[str]] = None) -> OnCallRole
    func GetOnCallRole(ctx *Context, name string, id IDInput, state *OnCallRoleState, opts ...ResourceOption) (*OnCallRole, error)
    public static OnCallRole Get(string name, Input<string> id, OnCallRoleState? state, CustomResourceOptions? opts = null)
    public static OnCallRole get(String name, Output<String> id, OnCallRoleState state, CustomResourceOptions options)
    resources:  _:    type: rootly:OnCallRole    get:      id: ${id}
    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:
    AlertFieldsPermissions List<string>
    Value must be one of create, read, update, delete.
    AlertGroupsPermissions List<string>
    Value must be one of create, read, update, delete.
    AlertRoutingRulesPermissions List<string>
    Value must be one of create, read, update, delete.
    AlertSourcesPermissions List<string>
    Value must be one of create, read, update, delete.
    AlertUrgencyPermissions List<string>
    Value must be one of create, read, update, delete.
    AlertsPermissions List<string>
    Value must be one of create, update, read, delete.
    ApiKeysPermissions List<string>
    Value must be one of create, read, update, delete.
    AuditsPermissions List<string>
    Value must be one of create, read, update, delete.
    ContactsPermissions List<string>
    Value must be one of read.
    EscalationPoliciesPermissions List<string>
    Value must be one of create, read, update, delete.
    GroupsPermissions List<string>
    Value must be one of create, read, update, delete.
    HeartbeatsPermissions List<string>
    Value must be one of create, read, update, delete.
    IntegrationsPermissions List<string>
    Value must be one of create, read, update, delete.
    InvitationsPermissions List<string>
    Value must be one of create, read, update, delete.
    LiveCallRoutingPermissions List<string>
    Value must be one of create, read, update, delete.
    Name string
    The role name.
    OnCallReadinessReportPermissions List<string>
    Value must be one of create, read, update, delete.
    OnCallRolesPermissions List<string>
    Value must be one of create, read, update, delete.
    ScheduleOverridePermissions List<string>
    Value must be one of create, update.
    SchedulesPermissions List<string>
    Value must be one of create, read, update, delete.
    ServicesPermissions List<string>
    Value must be one of create, read, update, delete.
    Slug string
    The role slug.
    SystemRole string
    The kind of role
    WebhooksPermissions List<string>
    Value must be one of create, read, update, delete.
    WorkflowsPermissions List<string>
    Value must be one of create, read, update, delete.
    AlertFieldsPermissions []string
    Value must be one of create, read, update, delete.
    AlertGroupsPermissions []string
    Value must be one of create, read, update, delete.
    AlertRoutingRulesPermissions []string
    Value must be one of create, read, update, delete.
    AlertSourcesPermissions []string
    Value must be one of create, read, update, delete.
    AlertUrgencyPermissions []string
    Value must be one of create, read, update, delete.
    AlertsPermissions []string
    Value must be one of create, update, read, delete.
    ApiKeysPermissions []string
    Value must be one of create, read, update, delete.
    AuditsPermissions []string
    Value must be one of create, read, update, delete.
    ContactsPermissions []string
    Value must be one of read.
    EscalationPoliciesPermissions []string
    Value must be one of create, read, update, delete.
    GroupsPermissions []string
    Value must be one of create, read, update, delete.
    HeartbeatsPermissions []string
    Value must be one of create, read, update, delete.
    IntegrationsPermissions []string
    Value must be one of create, read, update, delete.
    InvitationsPermissions []string
    Value must be one of create, read, update, delete.
    LiveCallRoutingPermissions []string
    Value must be one of create, read, update, delete.
    Name string
    The role name.
    OnCallReadinessReportPermissions []string
    Value must be one of create, read, update, delete.
    OnCallRolesPermissions []string
    Value must be one of create, read, update, delete.
    ScheduleOverridePermissions []string
    Value must be one of create, update.
    SchedulesPermissions []string
    Value must be one of create, read, update, delete.
    ServicesPermissions []string
    Value must be one of create, read, update, delete.
    Slug string
    The role slug.
    SystemRole string
    The kind of role
    WebhooksPermissions []string
    Value must be one of create, read, update, delete.
    WorkflowsPermissions []string
    Value must be one of create, read, update, delete.
    alertFieldsPermissions List<String>
    Value must be one of create, read, update, delete.
    alertGroupsPermissions List<String>
    Value must be one of create, read, update, delete.
    alertRoutingRulesPermissions List<String>
    Value must be one of create, read, update, delete.
    alertSourcesPermissions List<String>
    Value must be one of create, read, update, delete.
    alertUrgencyPermissions List<String>
    Value must be one of create, read, update, delete.
    alertsPermissions List<String>
    Value must be one of create, update, read, delete.
    apiKeysPermissions List<String>
    Value must be one of create, read, update, delete.
    auditsPermissions List<String>
    Value must be one of create, read, update, delete.
    contactsPermissions List<String>
    Value must be one of read.
    escalationPoliciesPermissions List<String>
    Value must be one of create, read, update, delete.
    groupsPermissions List<String>
    Value must be one of create, read, update, delete.
    heartbeatsPermissions List<String>
    Value must be one of create, read, update, delete.
    integrationsPermissions List<String>
    Value must be one of create, read, update, delete.
    invitationsPermissions List<String>
    Value must be one of create, read, update, delete.
    liveCallRoutingPermissions List<String>
    Value must be one of create, read, update, delete.
    name String
    The role name.
    onCallReadinessReportPermissions List<String>
    Value must be one of create, read, update, delete.
    onCallRolesPermissions List<String>
    Value must be one of create, read, update, delete.
    scheduleOverridePermissions List<String>
    Value must be one of create, update.
    schedulesPermissions List<String>
    Value must be one of create, read, update, delete.
    servicesPermissions List<String>
    Value must be one of create, read, update, delete.
    slug String
    The role slug.
    systemRole String
    The kind of role
    webhooksPermissions List<String>
    Value must be one of create, read, update, delete.
    workflowsPermissions List<String>
    Value must be one of create, read, update, delete.
    alertFieldsPermissions string[]
    Value must be one of create, read, update, delete.
    alertGroupsPermissions string[]
    Value must be one of create, read, update, delete.
    alertRoutingRulesPermissions string[]
    Value must be one of create, read, update, delete.
    alertSourcesPermissions string[]
    Value must be one of create, read, update, delete.
    alertUrgencyPermissions string[]
    Value must be one of create, read, update, delete.
    alertsPermissions string[]
    Value must be one of create, update, read, delete.
    apiKeysPermissions string[]
    Value must be one of create, read, update, delete.
    auditsPermissions string[]
    Value must be one of create, read, update, delete.
    contactsPermissions string[]
    Value must be one of read.
    escalationPoliciesPermissions string[]
    Value must be one of create, read, update, delete.
    groupsPermissions string[]
    Value must be one of create, read, update, delete.
    heartbeatsPermissions string[]
    Value must be one of create, read, update, delete.
    integrationsPermissions string[]
    Value must be one of create, read, update, delete.
    invitationsPermissions string[]
    Value must be one of create, read, update, delete.
    liveCallRoutingPermissions string[]
    Value must be one of create, read, update, delete.
    name string
    The role name.
    onCallReadinessReportPermissions string[]
    Value must be one of create, read, update, delete.
    onCallRolesPermissions string[]
    Value must be one of create, read, update, delete.
    scheduleOverridePermissions string[]
    Value must be one of create, update.
    schedulesPermissions string[]
    Value must be one of create, read, update, delete.
    servicesPermissions string[]
    Value must be one of create, read, update, delete.
    slug string
    The role slug.
    systemRole string
    The kind of role
    webhooksPermissions string[]
    Value must be one of create, read, update, delete.
    workflowsPermissions string[]
    Value must be one of create, read, update, delete.
    alert_fields_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    alert_groups_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    alert_routing_rules_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    alert_sources_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    alert_urgency_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    alerts_permissions Sequence[str]
    Value must be one of create, update, read, delete.
    api_keys_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    audits_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    contacts_permissions Sequence[str]
    Value must be one of read.
    escalation_policies_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    groups_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    heartbeats_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    integrations_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    invitations_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    live_call_routing_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    name str
    The role name.
    on_call_readiness_report_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    on_call_roles_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    schedule_override_permissions Sequence[str]
    Value must be one of create, update.
    schedules_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    services_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    slug str
    The role slug.
    system_role str
    The kind of role
    webhooks_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    workflows_permissions Sequence[str]
    Value must be one of create, read, update, delete.
    alertFieldsPermissions List<String>
    Value must be one of create, read, update, delete.
    alertGroupsPermissions List<String>
    Value must be one of create, read, update, delete.
    alertRoutingRulesPermissions List<String>
    Value must be one of create, read, update, delete.
    alertSourcesPermissions List<String>
    Value must be one of create, read, update, delete.
    alertUrgencyPermissions List<String>
    Value must be one of create, read, update, delete.
    alertsPermissions List<String>
    Value must be one of create, update, read, delete.
    apiKeysPermissions List<String>
    Value must be one of create, read, update, delete.
    auditsPermissions List<String>
    Value must be one of create, read, update, delete.
    contactsPermissions List<String>
    Value must be one of read.
    escalationPoliciesPermissions List<String>
    Value must be one of create, read, update, delete.
    groupsPermissions List<String>
    Value must be one of create, read, update, delete.
    heartbeatsPermissions List<String>
    Value must be one of create, read, update, delete.
    integrationsPermissions List<String>
    Value must be one of create, read, update, delete.
    invitationsPermissions List<String>
    Value must be one of create, read, update, delete.
    liveCallRoutingPermissions List<String>
    Value must be one of create, read, update, delete.
    name String
    The role name.
    onCallReadinessReportPermissions List<String>
    Value must be one of create, read, update, delete.
    onCallRolesPermissions List<String>
    Value must be one of create, read, update, delete.
    scheduleOverridePermissions List<String>
    Value must be one of create, update.
    schedulesPermissions List<String>
    Value must be one of create, read, update, delete.
    servicesPermissions List<String>
    Value must be one of create, read, update, delete.
    slug String
    The role slug.
    systemRole String
    The kind of role
    webhooksPermissions List<String>
    Value must be one of create, read, update, delete.
    workflowsPermissions List<String>
    Value must be one of create, read, update, delete.

    Import

    rootly.OnCallRole can be imported using the import command.

    $ pulumi import rootly:index/onCallRole:OnCallRole primary a816421c-6ceb-481a-87c4-585e47451f24
    

    You can also import by slug:

    $ pulumi import rootly:index/onCallRole:OnCallRole primary my-oncall-role-slug
    

    Or using an import block.

    Locate the resource id by listing on-call roles through the API (GET /v1/on_call_roles), as role IDs are not visible in the web app.

    HCL can be generated from the import block using the -generate-config-out flag.

    pulumi preview -generate-config-out=generated.tf
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    rootly rootlyhq/pulumi-rootly
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the rootly Terraform Provider.
    rootly logo
    Viewing docs for Rootly v3.3.0
    published on Thursday, May 7, 2026 by rootlyhq
      Try Pulumi Cloud free. Your team will thank you.