Openprovider MCP

Openprovider MCP Server — Tool Reference

97 tools, generated from the live tools/list catalog. Every tool authenticates with the tenant API key (see MCP-SERVER.md); there is no per-tool login.

Default mode is the out-of-the-box policy for a fresh tenant:

Owners can override any mode per tenant from the dashboard Policy page.

Contents

Confirmations (control plane)

Tool Default mode Description
list_pending_confirmations allow (always — policy bypass) List pending confirmations awaiting approval that the caller may approve.
confirm_pending allow (always — policy bypass) Approve and execute a previously proposed confirmation by id.

list_pending_confirmations

List pending confirmations awaiting approval that the caller may approve.

Default mode: allow (always — policy bypass)

Input schema:

{
  "type": "object",
  "properties": {},
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

confirm_pending

Approve and execute a previously proposed confirmation by id.

Default mode: allow (always — policy bypass)

Input schema:

{
  "type": "object",
  "properties": {
    "confirmation_id": {
      "type": "string",
      "format": "uuid"
    },
    "args": {}
  },
  "required": [
    "confirmation_id"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

DNS & Nameservers

Tool Default mode Description
list_dns_zones allow List all DNS zones.
get_dns_zone allow Get a DNS zone by domain name.
list_dns_zone_records allow List the DNS records of a zone.
list_nameservers allow List nameservers.
get_nameserver allow Get a nameserver by name.
list_ns_groups allow List nameserver groups.
get_ns_group allow Get a nameserver group by name.
list_dns_templates allow List DNS templates.
get_dns_template allow Get a DNS template by id.
create_dns_zone allow Create a DNS zone.
update_dns_zone allow Update a DNS zone (add/remove records).
create_nameserver allow Register a nameserver.
update_nameserver allow Update a nameserver's IPs.
create_ns_group allow Create a nameserver group.
update_ns_group allow Update a nameserver group (full replace).
create_dns_template allow Create a DNS template.
create_domain_token allow Create a DNS domain-control token.
delete_dns_zone confirm Delete a DNS zone (destructive; requires approval).
delete_nameserver confirm Delete a nameserver (requires approval).
delete_ns_group confirm Delete a nameserver group (requires approval).
delete_dns_template confirm Delete a DNS template (requires approval).

list_dns_zones

List all DNS zones.

Default mode: allow

Input schema:

{
  "type": "object",
  "properties": {},
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

get_dns_zone

Get a DNS zone by domain name.

Default mode: allow

Input schema:

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "name"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

list_dns_zone_records

List the DNS records of a zone.

Default mode: allow

Input schema:

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "name"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

list_nameservers

List nameservers.

Default mode: allow

Input schema:

{
  "type": "object",
  "properties": {},
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

get_nameserver

Get a nameserver by name.

Default mode: allow

Input schema:

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "name"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

list_ns_groups

List nameserver groups.

Default mode: allow

Input schema:

{
  "type": "object",
  "properties": {},
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

get_ns_group

Get a nameserver group by name.

Default mode: allow

Input schema:

{
  "type": "object",
  "properties": {
    "ns_group": {
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "ns_group"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

list_dns_templates

List DNS templates.

Default mode: allow

Input schema:

{
  "type": "object",
  "properties": {},
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

get_dns_template

Get a DNS template by id.

Default mode: allow

Input schema:

{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "exclusiveMinimum": 0
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

create_dns_zone

Create a DNS zone.

Default mode: allow

Input schema:

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "minLength": 1
        },
        "extension": {
          "type": "string",
          "minLength": 1
        }
      },
      "required": [
        "name",
        "extension"
      ],
      "additionalProperties": false
    },
    "provider": {
      "type": "string",
      "minLength": 1
    },
    "type": {
      "type": "string",
      "enum": [
        "master",
        "slave"
      ]
    },
    "master_ip": {
      "type": "string"
    },
    "secured": {
      "type": "boolean"
    },
    "template_name": {
      "type": "string"
    },
    "is_spamexperts_enabled": {
      "type": "boolean"
    },
    "records": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "minLength": 1
          },
          "value": {
            "type": "string",
            "minLength": 1
          },
          "ttl": {
            "type": "integer",
            "exclusiveMinimum": 0
          },
          "prio": {
            "type": "integer",
            "minimum": 0
          }
        },
        "required": [
          "type",
          "value",
          "ttl"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "domain",
    "provider",
    "type"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

update_dns_zone

Update a DNS zone (add/remove records).

Default mode: allow

Input schema:

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "minLength": 1
        },
        "extension": {
          "type": "string",
          "minLength": 1
        }
      },
      "required": [
        "name",
        "extension"
      ],
      "additionalProperties": false
    },
    "provider": {
      "type": "string",
      "minLength": 1
    },
    "type": {
      "type": "string",
      "enum": [
        "master",
        "slave"
      ]
    },
    "master_ip": {
      "type": "string"
    },
    "secured": {
      "type": "boolean"
    },
    "dnskey": {
      "type": "boolean"
    },
    "template_name": {
      "type": "string"
    },
    "is_spamexperts_enabled": {
      "type": "boolean"
    },
    "records": {
      "type": "object",
      "properties": {
        "add": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string"
              },
              "type": {
                "type": "string",
                "minLength": 1
              },
              "value": {
                "type": "string",
                "minLength": 1
              },
              "ttl": {
                "type": "integer",
                "exclusiveMinimum": 0
              },
              "prio": {
                "type": "integer",
                "minimum": 0
              }
            },
            "required": [
              "type",
              "value",
              "ttl"
            ],
            "additionalProperties": false
          }
        },
        "remove": {
          "type": "array",
          "items": {
            "$ref": "#/properties/records/properties/add/items"
          }
        }
      },
      "additionalProperties": false
    }
  },
  "required": [
    "domain"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

create_nameserver

Register a nameserver.

Default mode: allow

Input schema:

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1
    },
    "ip": {
      "type": "string",
      "minLength": 1
    },
    "ip6": {
      "type": "string"
    }
  },
  "required": [
    "name",
    "ip"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

update_nameserver

Update a nameserver's IPs.

Default mode: allow

Input schema:

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1
    },
    "ip": {
      "type": "string",
      "minLength": 1
    },
    "ip6": {
      "type": "string"
    }
  },
  "required": [
    "name",
    "ip"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

create_ns_group

Create a nameserver group.

Default mode: allow

Input schema:

{
  "type": "object",
  "properties": {
    "ns_group": {
      "type": "string",
      "minLength": 1
    },
    "name_servers": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "minimum": 0
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "ip": {
            "type": "string",
            "minLength": 1
          },
          "ip6": {
            "type": "string"
          },
          "seq_nr": {
            "type": "integer",
            "minimum": 0
          }
        },
        "required": [
          "name",
          "ip",
          "seq_nr"
        ],
        "additionalProperties": false
      },
      "minItems": 1
    }
  },
  "required": [
    "ns_group",
    "name_servers"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

update_ns_group

Update a nameserver group (full replace).

Default mode: allow

Input schema:

{
  "type": "object",
  "properties": {
    "ns_group": {
      "type": "string",
      "minLength": 1
    },
    "name_servers": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "minimum": 0
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "ip": {
            "type": "string",
            "minLength": 1
          },
          "ip6": {
            "type": "string"
          },
          "seq_nr": {
            "type": "integer",
            "minimum": 0
          }
        },
        "required": [
          "name",
          "ip",
          "seq_nr"
        ],
        "additionalProperties": false
      },
      "minItems": 1
    }
  },
  "required": [
    "ns_group",
    "name_servers"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

create_dns_template

Create a DNS template.

Default mode: allow

Input schema:

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1
    },
    "is_spamexperts_enabled": {
      "type": "boolean"
    },
    "records": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "minimum": 0
          },
          "name": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "minLength": 1
          },
          "value": {
            "type": "string",
            "minLength": 1
          },
          "ttl": {
            "type": "integer",
            "exclusiveMinimum": 0
          },
          "prio": {
            "type": "integer",
            "minimum": 0
          }
        },
        "required": [
          "type",
          "value",
          "ttl"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "name"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

create_domain_token

Create a DNS domain-control token.

Default mode: allow

Input schema:

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string",
      "minLength": 1
    },
    "zone_provider": {
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "domain",
    "zone_provider"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

delete_dns_zone

Delete a DNS zone (destructive; requires approval).

Default mode: confirm

Input schema:

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "name"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

delete_nameserver

Delete a nameserver (requires approval).

Default mode: confirm

Input schema:

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "name"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

delete_ns_group

Delete a nameserver group (requires approval).

Default mode: confirm

Input schema:

{
  "type": "object",
  "properties": {
    "ns_group": {
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "ns_group"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

delete_dns_template

Delete a DNS template (requires approval).

Default mode: confirm

Input schema:

{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "exclusiveMinimum": 0
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

TLD Catalog & Pricing

Tool Default mode Description
list_tlds allow List all TLDs.
get_tld allow Get TLD metadata by name.
get_domain_price allow Get the registration/renew/transfer/restore price for a domain.

list_tlds

List all TLDs.

Default mode: allow

Input schema:

{
  "type": "object",
  "properties": {},
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

get_tld

Get TLD metadata by name.

Default mode: allow

Input schema:

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "name"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

get_domain_price

Get the registration/renew/transfer/restore price for a domain.

Default mode: allow

Input schema:

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "minLength": 1
        },
        "extension": {
          "type": "string",
          "minLength": 1
        }
      },
      "required": [
        "name",
        "extension"
      ],
      "additionalProperties": false
    },
    "operation": {
      "type": "string",
      "enum": [
        "create",
        "transfer",
        "restore",
        "renew"
      ]
    },
    "additional_data": {
      "type": "object",
      "properties": {
        "idn_script": {
          "type": "string"
        }
      },
      "additionalProperties": false
    }
  },
  "required": [
    "domain",
    "operation"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Tags

Tool Default mode Description
list_tags allow List tags.
create_tag allow Create a tag (key/value pair).
delete_tag confirm Delete a tag by key/value (requires approval).

list_tags

List tags.

Default mode: allow

Input schema:

{
  "type": "object",
  "properties": {},
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

create_tag

Create a tag (key/value pair).

Default mode: allow

Input schema:

{
  "type": "object",
  "properties": {
    "key": {
      "type": "string",
      "minLength": 1
    },
    "value": {
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "key",
    "value"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

delete_tag

Delete a tag by key/value (requires approval).

Default mode: confirm

Input schema:

{
  "type": "object",
  "properties": {
    "key": {
      "type": "string",
      "minLength": 1
    },
    "value": {
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "key",
    "value"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

SSL

Tool Default mode Description
list_ssl_products allow List available SSL products.
get_ssl_product allow Get SSL product details by id.
list_ssl_orders allow List SSL orders.
get_ssl_order allow Get SSL order details by id.
get_ssl_approver_emails allow List valid approver emails for a domain.
update_ssl_order allow Update an SSL order.
update_ssl_approver_email allow Update the approver email of an SSL order.
resend_ssl_approver_email allow Resend the approver email for an SSL order.
create_csr allow Generate a CSR.
decode_csr allow Decode a CSR.
create_ssl_otp_token allow Create an OTP token for an SSL order.
create_ssl_order confirm Place an SSL order (billable; requires approval).
renew_ssl_order confirm Renew an SSL order (billable; requires approval).
reissue_ssl_order confirm Reissue an SSL order (billable; requires approval).
cancel_ssl_order confirm Cancel an SSL order (requires approval).

list_ssl_products

List available SSL products.

Default mode: allow

Input schema:

{
  "type": "object",
  "properties": {},
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

get_ssl_product

Get SSL product details by id.

Default mode: allow

Input schema:

{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "exclusiveMinimum": 0
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

list_ssl_orders

List SSL orders.

Default mode: allow

Input schema:

{
  "type": "object",
  "properties": {},
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

get_ssl_order

Get SSL order details by id.

Default mode: allow

Input schema:

{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "exclusiveMinimum": 0
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

get_ssl_approver_emails

List valid approver emails for a domain.

Default mode: allow

Input schema:

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "domain"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

update_ssl_order

Update an SSL order.

Default mode: allow

Input schema:

{
  "type": "object",
  "properties": {
    "approver_email": {
      "type": "string",
      "minLength": 1
    },
    "autorenew": {
      "type": "string",
      "enum": [
        "on",
        "off"
      ]
    },
    "csr": {
      "type": "string",
      "minLength": 1
    },
    "domain_amount": {
      "type": "integer",
      "minimum": 0
    },
    "domain_validation_methods": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "host_name": {
            "type": "string",
            "minLength": 1
          },
          "method": {
            "type": "string",
            "enum": [
              "dns",
              "email",
              "http"
            ]
          }
        },
        "required": [
          "host_name",
          "method"
        ],
        "additionalProperties": false
      },
      "minItems": 1
    },
    "enable_dns_automation": {
      "type": "boolean"
    },
    "host_names": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1
      },
      "minItems": 1
    },
    "organization_handle": {
      "type": "string",
      "minLength": 1
    },
    "period": {
      "type": "integer",
      "exclusiveMinimum": 0
    },
    "product_id": {
      "type": "integer",
      "exclusiveMinimum": 0
    },
    "signature_hash_algorithm": {
      "type": "string",
      "minLength": 1
    },
    "software_id": {
      "type": "string",
      "minLength": 1
    },
    "start_provision": {
      "type": "boolean"
    },
    "technical_handle": {
      "type": "string",
      "minLength": 1
    },
    "wildcard_domain_amount": {
      "type": "integer",
      "minimum": 0
    },
    "id": {
      "type": "integer",
      "exclusiveMinimum": 0
    }
  },
  "required": [
    "approver_email",
    "autorenew",
    "csr",
    "domain_amount",
    "domain_validation_methods",
    "enable_dns_automation",
    "host_names",
    "organization_handle",
    "period",
    "product_id",
    "signature_hash_algorithm",
    "software_id",
    "start_provision",
    "technical_handle",
    "wildcard_domain_amount",
    "id"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

update_ssl_approver_email

Update the approver email of an SSL order.

Default mode: allow

Input schema:

{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "exclusiveMinimum": 0
    },
    "approver_email": {
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "id",
    "approver_email"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

resend_ssl_approver_email

Resend the approver email for an SSL order.

Default mode: allow

Input schema:

{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "exclusiveMinimum": 0
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

create_csr

Generate a CSR.

Default mode: allow

Input schema:

{
  "type": "object",
  "properties": {
    "bits": {
      "type": "integer",
      "exclusiveMinimum": 0
    },
    "common_name": {
      "type": "string",
      "minLength": 1
    },
    "country": {
      "type": "string",
      "minLength": 2,
      "maxLength": 2
    },
    "email": {
      "type": "string",
      "minLength": 1
    },
    "locality": {
      "type": "string",
      "minLength": 1
    },
    "organization": {
      "type": "string",
      "minLength": 1
    },
    "signature_hash_algorithm": {
      "type": "string",
      "minLength": 1
    },
    "state": {
      "type": "string",
      "minLength": 1
    },
    "subject_alternative_name": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "unit": {
      "type": "string"
    },
    "with_config": {
      "type": "boolean"
    }
  },
  "required": [
    "bits",
    "common_name",
    "country",
    "email",
    "locality",
    "organization",
    "signature_hash_algorithm",
    "state"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

decode_csr

Decode a CSR.

Default mode: allow

Input schema:

{
  "type": "object",
  "properties": {
    "csr": {
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "csr"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

create_ssl_otp_token

Create an OTP token for an SSL order.

Default mode: allow

Input schema:

{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "exclusiveMinimum": 0
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

create_ssl_order

Place an SSL order (billable; requires approval).

Default mode: confirm

Input schema:

{
  "type": "object",
  "properties": {
    "approver_email": {
      "type": "string",
      "minLength": 1
    },
    "autorenew": {
      "type": "string",
      "enum": [
        "on",
        "off"
      ]
    },
    "csr": {
      "type": "string",
      "minLength": 1
    },
    "domain_amount": {
      "type": "integer",
      "minimum": 0
    },
    "domain_validation_methods": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "host_name": {
            "type": "string",
            "minLength": 1
          },
          "method": {
            "type": "string",
            "enum": [
              "dns",
              "email",
              "http"
            ]
          }
        },
        "required": [
          "host_name",
          "method"
        ],
        "additionalProperties": false
      },
      "minItems": 1
    },
    "enable_dns_automation": {
      "type": "boolean"
    },
    "host_names": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1
      },
      "minItems": 1
    },
    "organization_handle": {
      "type": "string",
      "minLength": 1
    },
    "period": {
      "type": "integer",
      "exclusiveMinimum": 0
    },
    "product_id": {
      "type": "integer",
      "exclusiveMinimum": 0
    },
    "signature_hash_algorithm": {
      "type": "string",
      "minLength": 1
    },
    "software_id": {
      "type": "string",
      "minLength": 1
    },
    "start_provision": {
      "type": "boolean"
    },
    "technical_handle": {
      "type": "string",
      "minLength": 1
    },
    "wildcard_domain_amount": {
      "type": "integer",
      "minimum": 0
    }
  },
  "required": [
    "approver_email",
    "autorenew",
    "csr",
    "domain_amount",
    "domain_validation_methods",
    "enable_dns_automation",
    "host_names",
    "organization_handle",
    "period",
    "product_id",
    "signature_hash_algorithm",
    "software_id",
    "start_provision",
    "technical_handle",
    "wildcard_domain_amount"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

renew_ssl_order

Renew an SSL order (billable; requires approval).

Default mode: confirm

Input schema:

{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "exclusiveMinimum": 0
    },
    "enable_dns_automation": {
      "type": "boolean"
    }
  },
  "required": [
    "id",
    "enable_dns_automation"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

reissue_ssl_order

Reissue an SSL order (billable; requires approval).

Default mode: confirm

Input schema:

{
  "type": "object",
  "properties": {
    "approver_email": {
      "type": "string",
      "minLength": 1
    },
    "autorenew": {
      "type": "string",
      "enum": [
        "on",
        "off"
      ]
    },
    "csr": {
      "type": "string",
      "minLength": 1
    },
    "domain_amount": {
      "type": "integer",
      "minimum": 0
    },
    "domain_validation_methods": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "host_name": {
            "type": "string",
            "minLength": 1
          },
          "method": {
            "type": "string",
            "enum": [
              "dns",
              "email",
              "http"
            ]
          }
        },
        "required": [
          "host_name",
          "method"
        ],
        "additionalProperties": false
      },
      "minItems": 1
    },
    "enable_dns_automation": {
      "type": "boolean"
    },
    "host_names": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1
      },
      "minItems": 1
    },
    "organization_handle": {
      "type": "string",
      "minLength": 1
    },
    "period": {
      "type": "integer",
      "exclusiveMinimum": 0
    },
    "product_id": {
      "type": "integer",
      "exclusiveMinimum": 0
    },
    "signature_hash_algorithm": {
      "type": "string",
      "minLength": 1
    },
    "software_id": {
      "type": "string",
      "minLength": 1
    },
    "start_provision": {
      "type": "boolean"
    },
    "technical_handle": {
      "type": "string",
      "minLength": 1
    },
    "wildcard_domain_amount": {
      "type": "integer",
      "minimum": 0
    },
    "id": {
      "type": "integer",
      "exclusiveMinimum": 0
    }
  },
  "required": [
    "approver_email",
    "autorenew",
    "csr",
    "domain_amount",
    "domain_validation_methods",
    "enable_dns_automation",
    "host_names",
    "organization_handle",
    "period",
    "product_id",
    "signature_hash_algorithm",
    "software_id",
    "start_provision",
    "technical_handle",
    "wildcard_domain_amount",
    "id"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

cancel_ssl_order

Cancel an SSL order (requires approval).

Default mode: confirm

Input schema:

{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "exclusiveMinimum": 0
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Customers

Tool Default mode Description
list_customers allow List customers.
get_customer allow Get customer details by handle.
create_customer allow Create a customer (contact).
update_customer allow Update a customer (contact).
delete_customer confirm Delete a customer (requires approval).

list_customers

List customers.

Default mode: allow

Input schema:

{
  "type": "object",
  "properties": {},
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

get_customer

Get customer details by handle.

Default mode: allow

Input schema:

{
  "type": "object",
  "properties": {
    "handle": {
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "handle"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

create_customer

Create a customer (contact).

Default mode: allow

Input schema:

{
  "type": "object",
  "properties": {
    "email": {
      "type": "string",
      "minLength": 1
    },
    "username": {
      "type": "string",
      "minLength": 1
    },
    "name": {
      "type": "object",
      "properties": {
        "first_name": {
          "type": "string",
          "minLength": 1
        },
        "last_name": {
          "type": "string",
          "minLength": 1
        },
        "full_name": {
          "type": "string"
        },
        "initials": {
          "type": "string"
        },
        "prefix": {
          "type": "string"
        }
      },
      "required": [
        "first_name",
        "last_name"
      ],
      "additionalProperties": false
    },
    "address": {
      "type": "object",
      "properties": {
        "street": {
          "type": "string",
          "minLength": 1
        },
        "number": {
          "type": "string",
          "minLength": 1
        },
        "city": {
          "type": "string",
          "minLength": 1
        },
        "zipcode": {
          "type": "string",
          "minLength": 1
        },
        "state": {
          "type": "string"
        },
        "country": {
          "type": "string",
          "minLength": 2,
          "maxLength": 2
        },
        "suffix": {
          "type": "string"
        }
      },
      "required": [
        "street",
        "number",
        "city",
        "zipcode",
        "country"
      ],
      "additionalProperties": false
    },
    "phone": {
      "type": "object",
      "properties": {
        "country_code": {
          "type": "string",
          "minLength": 1
        },
        "area_code": {
          "type": "string",
          "minLength": 1
        },
        "subscriber_number": {
          "type": "string",
          "minLength": 1
        }
      },
      "required": [
        "country_code",
        "area_code",
        "subscriber_number"
      ],
      "additionalProperties": false
    },
    "fax": {
      "type": "object",
      "properties": {
        "country_code": {
          "type": "string"
        },
        "area_code": {
          "type": "string"
        },
        "subscriber_number": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "tags": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string"
          },
          "value": {
            "type": "string"
          }
        },
        "required": [
          "key",
          "value"
        ],
        "additionalProperties": false
      }
    },
    "company_name": {
      "type": "string"
    },
    "comments": {
      "type": "string"
    },
    "locale": {
      "type": "string"
    },
    "vat": {
      "type": "string"
    },
    "additional_data": {
      "type": "object",
      "additionalProperties": {}
    },
    "extension_additional_data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "data": {
            "type": "object",
            "additionalProperties": {}
          }
        },
        "required": [
          "name",
          "data"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "email",
    "username",
    "name",
    "address",
    "phone"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

update_customer

Update a customer (contact).

Default mode: allow

Input schema:

{
  "type": "object",
  "properties": {
    "handle": {
      "type": "string",
      "minLength": 1
    },
    "email": {
      "type": "string",
      "minLength": 1
    },
    "name": {
      "type": "object",
      "properties": {
        "first_name": {
          "type": "string",
          "minLength": 1
        },
        "last_name": {
          "type": "string",
          "minLength": 1
        },
        "full_name": {
          "type": "string"
        },
        "initials": {
          "type": "string"
        },
        "prefix": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "address": {
      "type": "object",
      "properties": {
        "street": {
          "type": "string",
          "minLength": 1
        },
        "number": {
          "type": "string",
          "minLength": 1
        },
        "city": {
          "type": "string",
          "minLength": 1
        },
        "zipcode": {
          "type": "string",
          "minLength": 1
        },
        "state": {
          "type": "string"
        },
        "country": {
          "type": "string",
          "minLength": 2,
          "maxLength": 2
        },
        "suffix": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "phone": {
      "type": "object",
      "properties": {
        "country_code": {
          "type": "string",
          "minLength": 1
        },
        "area_code": {
          "type": "string",
          "minLength": 1
        },
        "subscriber_number": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    },
    "fax": {
      "type": "object",
      "properties": {
        "country_code": {
          "type": "string"
        },
        "area_code": {
          "type": "string"
        },
        "subscriber_number": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "tags": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string"
          },
          "value": {
            "type": "string"
          }
        },
        "required": [
          "key",
          "value"
        ],
        "additionalProperties": false
      }
    },
    "company_name": {
      "type": "string"
    },
    "comments": {
      "type": "string"
    },
    "locale": {
      "type": "string"
    },
    "vat": {
      "type": "string"
    },
    "additional_data": {
      "type": "object",
      "additionalProperties": {}
    },
    "extension_additional_data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "data": {
            "type": "object",
            "additionalProperties": {}
          }
        },
        "required": [
          "name",
          "data"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "handle"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

delete_customer

Delete a customer (requires approval).

Default mode: confirm

Input schema:

{
  "type": "object",
  "properties": {
    "handle": {
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "handle"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Contacts

Tool Default mode Description
list_contacts allow List contacts in the tenant's Openprovider account.
get_contact allow Get details for one contact by Openprovider contact id.
create_contact allow Create a new contact (handle) in the tenant’s Openprovider account.
update_contact confirm Update an existing contact by id.
delete_contact confirm Delete a contact by id (destructive).

list_contacts

List contacts in the tenant's Openprovider account.

Default mode: allow

Input schema:

{
  "type": "object",
  "properties": {
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 500,
      "default": 100
    },
    "offset": {
      "type": "integer",
      "minimum": 0,
      "default": 0
    }
  },
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

get_contact

Get details for one contact by Openprovider contact id.

Default mode: allow

Input schema:

{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "exclusiveMinimum": 0
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

create_contact

Create a new contact (handle) in the tenant’s Openprovider account.

Default mode: allow

Input schema:

{
  "type": "object",
  "properties": {
    "name": {
      "type": "object",
      "properties": {
        "first_name": {
          "type": "string",
          "minLength": 1
        },
        "last_name": {
          "type": "string",
          "minLength": 1
        },
        "full_name": {
          "type": "string"
        },
        "initials": {
          "type": "string"
        },
        "prefix": {
          "type": "string"
        }
      },
      "required": [
        "first_name",
        "last_name"
      ],
      "additionalProperties": false
    },
    "phone": {
      "type": "object",
      "properties": {
        "country_code": {
          "type": "string",
          "minLength": 1
        },
        "subscriber_number": {
          "type": "string",
          "minLength": 1
        },
        "area_code": {
          "type": "string"
        }
      },
      "required": [
        "country_code",
        "subscriber_number"
      ],
      "additionalProperties": false
    },
    "address": {
      "type": "object",
      "properties": {
        "street": {
          "type": "string",
          "minLength": 1
        },
        "number": {
          "type": "string",
          "minLength": 1
        },
        "city": {
          "type": "string",
          "minLength": 1
        },
        "zipcode": {
          "type": "string",
          "minLength": 1
        },
        "country": {
          "type": "string",
          "minLength": 2,
          "maxLength": 2
        },
        "state": {
          "type": "string"
        },
        "suffix": {
          "type": "string"
        }
      },
      "required": [
        "street",
        "number",
        "city",
        "zipcode",
        "country"
      ],
      "additionalProperties": false
    },
    "email": {
      "type": "string",
      "format": "email"
    },
    "company_name": {
      "type": "string"
    },
    "vat": {
      "type": "string"
    },
    "gender": {
      "type": "string",
      "enum": [
        "M",
        "F"
      ]
    },
    "role": {
      "type": "string",
      "enum": [
        "admin",
        "tech",
        "billing",
        "owner"
      ]
    }
  },
  "required": [
    "name",
    "phone",
    "address"
  ],
  "additionalProperties": true,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

update_contact

Update an existing contact by id.

Default mode: confirm

Input schema:

{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "exclusiveMinimum": 0
    },
    "name": {
      "type": "object",
      "properties": {
        "first_name": {
          "type": "string",
          "minLength": 1
        },
        "last_name": {
          "type": "string",
          "minLength": 1
        },
        "full_name": {
          "type": "string"
        },
        "initials": {
          "type": "string"
        },
        "prefix": {
          "type": "string"
        }
      },
      "required": [
        "first_name",
        "last_name"
      ],
      "additionalProperties": false
    },
    "phone": {
      "type": "object",
      "properties": {
        "country_code": {
          "type": "string",
          "minLength": 1
        },
        "subscriber_number": {
          "type": "string",
          "minLength": 1
        },
        "area_code": {
          "type": "string"
        }
      },
      "required": [
        "country_code",
        "subscriber_number"
      ],
      "additionalProperties": false
    },
    "address": {
      "type": "object",
      "properties": {
        "street": {
          "type": "string",
          "minLength": 1
        },
        "number": {
          "type": "string",
          "minLength": 1
        },
        "city": {
          "type": "string",
          "minLength": 1
        },
        "zipcode": {
          "type": "string",
          "minLength": 1
        },
        "country": {
          "type": "string",
          "minLength": 2,
          "maxLength": 2
        },
        "state": {
          "type": "string"
        },
        "suffix": {
          "type": "string"
        }
      },
      "required": [
        "street",
        "number",
        "city",
        "zipcode",
        "country"
      ],
      "additionalProperties": false
    },
    "email": {
      "type": "string",
      "format": "email"
    },
    "company_name": {
      "type": "string"
    },
    "vat": {
      "type": "string"
    },
    "gender": {
      "type": "string",
      "enum": [
        "M",
        "F"
      ]
    },
    "role": {
      "type": "string",
      "enum": [
        "admin",
        "tech",
        "billing",
        "owner"
      ]
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": true,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

delete_contact

Delete a contact by id (destructive).

Default mode: confirm

Input schema:

{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "exclusiveMinimum": 0
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Email & Deliverability

Tool Default mode Description
list_email_templates allow List email templates.
create_email_template allow Create an email template.
update_email_template allow Update an email template.
delete_email_template confirm Delete an email template (requires approval).
list_email_verification_domains allow List domains usable for customer email verification.
start_email_verification allow Start an email verification flow for a customer.
restart_email_verification allow Restart an email verification flow.
get_dmarc allow Get the EasyDmarc subscription for a domain.
list_dmarc_subscriptions allow List EasyDmarc subscriptions.
create_dmarc allow Create an EasyDmarc subscription for a domain.
retry_dmarc allow Retry an EasyDmarc subscription.
dmarc_sso_login allow Get the EasyDmarc SSO login URL.
delete_dmarc confirm Delete an EasyDmarc subscription (requires approval).
get_spam_experts_domain allow Get a SpamExperts domain configuration.
spam_experts_login_url allow Generate a SpamExperts dashboard login URL.
create_spam_experts_domain allow Provision a SpamExperts domain.
update_spam_experts_domain allow Update a SpamExperts domain.
delete_spam_experts_domain confirm Delete a SpamExperts domain (requires approval).

list_email_templates

List email templates.

Default mode: allow

Input schema:

{
  "type": "object",
  "properties": {},
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

create_email_template

Create an email template.

Default mode: allow

Input schema:

{
  "type": "object",
  "properties": {
    "group": {
      "type": "string",
      "minLength": 1
    },
    "name": {
      "type": "string",
      "minLength": 1
    },
    "id": {
      "type": "integer",
      "minimum": 0
    },
    "fields": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "value": {
            "type": "string"
          }
        },
        "required": [
          "name",
          "value"
        ],
        "additionalProperties": false
      }
    },
    "locale": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "tags": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string"
          },
          "value": {
            "type": "string"
          }
        },
        "required": [
          "key",
          "value"
        ],
        "additionalProperties": false
      }
    },
    "is_active": {
      "type": "boolean"
    },
    "is_default": {
      "type": "boolean"
    }
  },
  "required": [
    "group",
    "name"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

update_email_template

Update an email template.

Default mode: allow

Input schema:

{
  "type": "object",
  "properties": {
    "group": {
      "type": "string",
      "minLength": 1
    },
    "name": {
      "type": "string",
      "minLength": 1
    },
    "id": {
      "type": "integer",
      "exclusiveMinimum": 0
    },
    "fields": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "value": {
            "type": "string"
          }
        },
        "required": [
          "name",
          "value"
        ],
        "additionalProperties": false
      }
    },
    "locale": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "tags": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string"
          },
          "value": {
            "type": "string"
          }
        },
        "required": [
          "key",
          "value"
        ],
        "additionalProperties": false
      }
    },
    "is_active": {
      "type": "boolean"
    },
    "is_default": {
      "type": "boolean"
    }
  },
  "required": [
    "group",
    "name",
    "id"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

delete_email_template

Delete an email template (requires approval).

Default mode: confirm

Input schema:

{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "exclusiveMinimum": 0
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

list_email_verification_domains

List domains usable for customer email verification.

Default mode: allow

Input schema:

{
  "type": "object",
  "properties": {},
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

start_email_verification

Start an email verification flow for a customer.

Default mode: allow

Input schema:

{
  "type": "object",
  "properties": {
    "email": {
      "type": "string",
      "minLength": 1
    },
    "handle": {
      "type": "string",
      "minLength": 1
    },
    "language": {
      "type": "string"
    },
    "tag": {
      "type": "string"
    }
  },
  "required": [
    "email",
    "handle"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

restart_email_verification

Restart an email verification flow.

Default mode: allow

Input schema:

{
  "type": "object",
  "properties": {
    "email": {
      "type": "string",
      "minLength": 1
    },
    "handle": {
      "type": "string",
      "minLength": 1
    },
    "language": {
      "type": "string"
    },
    "tag": {
      "type": "string"
    }
  },
  "required": [
    "email",
    "handle"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

get_dmarc

Get the EasyDmarc subscription for a domain.

Default mode: allow

Input schema:

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "minLength": 1
        },
        "extension": {
          "type": "string",
          "minLength": 1
        }
      },
      "required": [
        "name",
        "extension"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "domain"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

list_dmarc_subscriptions

List EasyDmarc subscriptions.

Default mode: allow

Input schema:

{
  "type": "object",
  "properties": {},
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

create_dmarc

Create an EasyDmarc subscription for a domain.

Default mode: allow

Input schema:

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "minLength": 1
        },
        "extension": {
          "type": "string",
          "minLength": 1
        }
      },
      "required": [
        "name",
        "extension"
      ],
      "additionalProperties": false
    },
    "owner_handle": {
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "domain",
    "owner_handle"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

retry_dmarc

Retry an EasyDmarc subscription.

Default mode: allow

Input schema:

{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "exclusiveMinimum": 0
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

dmarc_sso_login

Get the EasyDmarc SSO login URL.

Default mode: allow

Input schema:

{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "exclusiveMinimum": 0
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

delete_dmarc

Delete an EasyDmarc subscription (requires approval).

Default mode: confirm

Input schema:

{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "exclusiveMinimum": 0
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

get_spam_experts_domain

Get a SpamExperts domain configuration.

Default mode: allow

Input schema:

{
  "type": "object",
  "properties": {
    "domain_name": {
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "domain_name"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

spam_experts_login_url

Generate a SpamExperts dashboard login URL.

Default mode: allow

Input schema:

{
  "type": "object",
  "properties": {
    "bundle": {
      "type": "boolean"
    },
    "domain_or_email": {
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "bundle",
    "domain_or_email"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

create_spam_experts_domain

Provision a SpamExperts domain.

Default mode: allow

Input schema:

{
  "type": "object",
  "properties": {
    "aliases": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "bundle": {
      "type": "boolean"
    },
    "destinations": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "hostname": {
            "type": "string",
            "minLength": 1
          },
          "port": {
            "type": "integer",
            "exclusiveMinimum": 0
          }
        },
        "required": [
          "hostname",
          "port"
        ],
        "additionalProperties": false
      },
      "minItems": 1
    },
    "domain_name": {
      "type": "string",
      "minLength": 1
    },
    "products": {
      "type": "object",
      "properties": {
        "archiving": {
          "type": "boolean"
        },
        "incoming": {
          "type": "boolean"
        },
        "outgoing": {
          "type": "boolean"
        }
      },
      "required": [
        "archiving",
        "incoming",
        "outgoing"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "bundle",
    "destinations",
    "domain_name",
    "products"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

update_spam_experts_domain

Update a SpamExperts domain.

Default mode: allow

Input schema:

{
  "type": "object",
  "properties": {
    "domain_name": {
      "type": "string",
      "minLength": 1
    },
    "bundle": {
      "type": "boolean"
    },
    "destinations": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "hostname": {
            "type": "string",
            "minLength": 1
          },
          "port": {
            "type": "integer",
            "exclusiveMinimum": 0
          }
        },
        "required": [
          "hostname",
          "port"
        ],
        "additionalProperties": false
      },
      "minItems": 1
    },
    "products": {
      "type": "object",
      "properties": {
        "archiving": {
          "type": "boolean"
        },
        "incoming": {
          "type": "boolean"
        },
        "outgoing": {
          "type": "boolean"
        }
      },
      "required": [
        "archiving",
        "incoming",
        "outgoing"
      ],
      "additionalProperties": false
    },
    "aliases": {
      "type": "object",
      "properties": {
        "add": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "remove": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false
    }
  },
  "required": [
    "domain_name",
    "bundle",
    "destinations",
    "products"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

delete_spam_experts_domain

Delete a SpamExperts domain (requires approval).

Default mode: confirm

Input schema:

{
  "type": "object",
  "properties": {
    "domain_name": {
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "domain_name"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Licenses (Plesk)

Tool Default mode Description
list_license_prices allow List licenses with pricing.
list_license_items allow List license catalog items (SKUs).
list_plesk_licenses allow List provisioned Plesk licenses.
get_plesk_license allow Get a Plesk license by key id.
get_plesk_key allow Get the Plesk activation key for a license.
create_plesk_license confirm Provision a new Plesk license (billable; requires approval).
update_plesk_license allow Update a Plesk license.
reset_plesk_hwid allow Reset the HWID binding of a Plesk license.
delete_plesk_license confirm Delete a Plesk license (requires approval).

list_license_prices

List licenses with pricing.

Default mode: allow

Input schema:

{
  "type": "object",
  "properties": {},
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

list_license_items

List license catalog items (SKUs).

Default mode: allow

Input schema:

{
  "type": "object",
  "properties": {},
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

list_plesk_licenses

List provisioned Plesk licenses.

Default mode: allow

Input schema:

{
  "type": "object",
  "properties": {},
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

get_plesk_license

Get a Plesk license by key id.

Default mode: allow

Input schema:

{
  "type": "object",
  "properties": {
    "key_id": {
      "type": "integer",
      "exclusiveMinimum": 0
    }
  },
  "required": [
    "key_id"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

get_plesk_key

Get the Plesk activation key for a license.

Default mode: allow

Input schema:

{
  "type": "object",
  "properties": {
    "key_id": {
      "type": "integer",
      "exclusiveMinimum": 0
    }
  },
  "required": [
    "key_id"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

create_plesk_license

Provision a new Plesk license (billable; requires approval).

Default mode: confirm

Input schema:

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1
      },
      "minItems": 1
    },
    "period": {
      "type": "integer",
      "exclusiveMinimum": 0
    },
    "ip_address_binding": {
      "type": "string",
      "minLength": 1
    },
    "title": {
      "type": "string",
      "minLength": 1
    },
    "attached_keys": {
      "type": "array",
      "items": {}
    },
    "comment": {
      "type": "string"
    },
    "parent_key_id": {
      "type": "integer",
      "minimum": 0
    },
    "restrict_ip_binding": {
      "type": "boolean"
    }
  },
  "required": [
    "items",
    "period",
    "ip_address_binding",
    "title"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

update_plesk_license

Update a Plesk license.

Default mode: allow

Input schema:

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1
      },
      "minItems": 1
    },
    "period": {
      "type": "integer",
      "exclusiveMinimum": 0
    },
    "ip_address_binding": {
      "type": "string",
      "minLength": 1
    },
    "title": {
      "type": "string",
      "minLength": 1
    },
    "attached_keys": {
      "type": "array",
      "items": {}
    },
    "comment": {
      "type": "string"
    },
    "parent_key_id": {
      "type": "integer",
      "minimum": 0
    },
    "restrict_ip_binding": {
      "type": "boolean"
    },
    "key_id": {
      "type": "integer",
      "exclusiveMinimum": 0
    }
  },
  "required": [
    "items",
    "period",
    "ip_address_binding",
    "title",
    "key_id"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

reset_plesk_hwid

Reset the HWID binding of a Plesk license.

Default mode: allow

Input schema:

{
  "type": "object",
  "properties": {
    "key_id": {
      "type": "integer",
      "exclusiveMinimum": 0
    },
    "product": {
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "key_id",
    "product"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

delete_plesk_license

Delete a Plesk license (requires approval).

Default mode: confirm

Input schema:

{
  "type": "object",
  "properties": {
    "key_id": {
      "type": "integer",
      "exclusiveMinimum": 0
    }
  },
  "required": [
    "key_id"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Domains

Tool Default mode Description
check_domain allow Check whether one or more domains are available for registration with Openprovider, optionally with prices. Batch limit: up to 15 domains per call (Openprovider rejects larger batches with a 500). To check more, split into multiple calls of ≤15 each.
list_domains allow List domains in the tenant's Openprovider account.
get_domain allow Get details for one domain by Openprovider domain id.
register_domain confirm Register a new domain (billable). Requires an existing owner contact handle.
update_domain confirm Update a domain (nameservers, autorenew, DNSSEC, WHOIS privacy).
suggest_domain allow Suggest available domain names for a base name across TLDs.
get_domain_authcode allow Get the EPP auth/transfer code for a domain.
reset_domain_authcode allow Reset/regenerate a domain's EPP auth code.
approve_domain_transfer allow Approve an inbound/outbound domain transfer.
send_foa1_domain_transfer allow Send the FOA1 transfer-confirmation email for a domain.
delete_domain confirm Delete a domain (destructive; requires approval).
restart_domain_operation confirm Restart the last domain operation (may re-bill; requires approval).
renew_domain confirm Renew a domain for N years (billable; requires approval).
transfer_domain confirm Transfer a domain in (billable; requires approval).
trade_domain confirm Trade (change owner of) a domain (billable; requires approval).
restore_domain confirm Restore a domain from redemption (billable; requires approval).

check_domain

Check whether one or more domains are available for registration with Openprovider, optionally with prices. Batch limit: up to 15 domains per call (Openprovider rejects larger batches with a 500). To check more, split into multiple calls of ≤15 each.

Default mode: allow

Input schema:

{
  "type": "object",
  "properties": {
    "domains": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "minLength": 1
          },
          "extension": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "name",
          "extension"
        ],
        "additionalProperties": false
      },
      "minItems": 1,
      "maxItems": 15
    },
    "with_price": {
      "type": "boolean",
      "default": true
    }
  },
  "required": [
    "domains"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

list_domains

List domains in the tenant's Openprovider account.

Default mode: allow

Input schema:

{
  "type": "object",
  "properties": {
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 500,
      "default": 100
    },
    "offset": {
      "type": "integer",
      "minimum": 0,
      "default": 0
    },
    "status": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

get_domain

Get details for one domain by Openprovider domain id.

Default mode: allow

Input schema:

{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "exclusiveMinimum": 0
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

register_domain

Register a new domain (billable). Requires an existing owner contact handle.

Default mode: confirm

Input schema:

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "minLength": 1
        },
        "extension": {
          "type": "string",
          "minLength": 1
        }
      },
      "required": [
        "name",
        "extension"
      ],
      "additionalProperties": false
    },
    "period": {
      "type": "integer",
      "minimum": 1,
      "maximum": 10
    },
    "owner_handle": {
      "type": "string",
      "minLength": 1
    },
    "admin_handle": {
      "type": "string"
    },
    "tech_handle": {
      "type": "string"
    },
    "billing_handle": {
      "type": "string"
    },
    "name_servers": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "minLength": 1
          },
          "ip": {
            "type": "string"
          },
          "ip6": {
            "type": "string"
          }
        },
        "required": [
          "name"
        ],
        "additionalProperties": false
      }
    },
    "ns_group": {
      "type": "string"
    },
    "is_private_whois_enabled": {
      "type": "boolean"
    },
    "is_dnssec_enabled": {
      "type": "boolean"
    },
    "autorenew": {
      "type": "string",
      "enum": [
        "on",
        "off",
        "default"
      ]
    }
  },
  "required": [
    "domain",
    "period",
    "owner_handle"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

update_domain

Update a domain (nameservers, autorenew, DNSSEC, WHOIS privacy).

Default mode: confirm

Input schema:

{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "exclusiveMinimum": 0
    },
    "name_servers": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "minLength": 1
          },
          "ip": {
            "type": "string"
          },
          "ip6": {
            "type": "string"
          }
        },
        "required": [
          "name"
        ],
        "additionalProperties": false
      }
    },
    "ns_group": {
      "type": "string"
    },
    "is_private_whois_enabled": {
      "type": "boolean"
    },
    "is_dnssec_enabled": {
      "type": "boolean"
    },
    "autorenew": {
      "type": "string",
      "enum": [
        "on",
        "off",
        "default"
      ]
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

suggest_domain

Suggest available domain names for a base name across TLDs.

Default mode: allow

Input schema:

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1
    },
    "tlds": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "language": {
      "type": "string"
    },
    "limit": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 100
    },
    "provider": {
      "type": "string"
    },
    "sensitive": {
      "type": "boolean"
    }
  },
  "required": [
    "name"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

get_domain_authcode

Get the EPP auth/transfer code for a domain.

Default mode: allow

Input schema:

{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "exclusiveMinimum": 0
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

reset_domain_authcode

Reset/regenerate a domain's EPP auth code.

Default mode: allow

Input schema:

{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "exclusiveMinimum": 0
    },
    "domain": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "minLength": 1
        },
        "extension": {
          "type": "string",
          "minLength": 1
        }
      },
      "required": [
        "name",
        "extension"
      ],
      "additionalProperties": false
    },
    "auth_code_type": {
      "type": "string",
      "enum": [
        "internal",
        "registry"
      ]
    },
    "sending_type": {
      "type": "string"
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

approve_domain_transfer

Approve an inbound/outbound domain transfer.

Default mode: allow

Input schema:

{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "exclusiveMinimum": 0
    },
    "approve": {
      "type": "number",
      "enum": [
        0,
        1
      ]
    },
    "auth_code": {
      "type": "string"
    },
    "domain": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "minLength": 1
        },
        "extension": {
          "type": "string",
          "minLength": 1
        }
      },
      "required": [
        "name",
        "extension"
      ],
      "additionalProperties": false
    },
    "registrar_tag": {
      "type": "string"
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

send_foa1_domain_transfer

Send the FOA1 transfer-confirmation email for a domain.

Default mode: allow

Input schema:

{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "exclusiveMinimum": 0
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

delete_domain

Delete a domain (destructive; requires approval).

Default mode: confirm

Input schema:

{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "exclusiveMinimum": 0
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

restart_domain_operation

Restart the last domain operation (may re-bill; requires approval).

Default mode: confirm

Input schema:

{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "exclusiveMinimum": 0
    },
    "auth_code": {
      "type": "string"
    },
    "domain": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "minLength": 1
        },
        "extension": {
          "type": "string",
          "minLength": 1
        }
      },
      "required": [
        "name",
        "extension"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

renew_domain

Renew a domain for N years (billable; requires approval).

Default mode: confirm

Input schema:

{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "exclusiveMinimum": 0
    },
    "period": {
      "type": "integer",
      "exclusiveMinimum": 0
    },
    "domain": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "minLength": 1
        },
        "extension": {
          "type": "string",
          "minLength": 1
        }
      },
      "required": [
        "name",
        "extension"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "id",
    "period"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

transfer_domain

Transfer a domain in (billable; requires approval).

Default mode: confirm

Input schema:

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "minLength": 1
        },
        "extension": {
          "type": "string",
          "minLength": 1
        }
      },
      "required": [
        "name",
        "extension"
      ],
      "additionalProperties": false
    },
    "auth_code": {
      "type": "string",
      "minLength": 1
    },
    "owner_handle": {
      "type": "string",
      "minLength": 1
    },
    "admin_handle": {
      "type": "string"
    },
    "tech_handle": {
      "type": "string"
    },
    "billing_handle": {
      "type": "string"
    },
    "ns_group": {
      "type": "string"
    }
  },
  "required": [
    "domain",
    "auth_code",
    "owner_handle"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

trade_domain

Trade (change owner of) a domain (billable; requires approval).

Default mode: confirm

Input schema:

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "minLength": 1
        },
        "extension": {
          "type": "string",
          "minLength": 1
        }
      },
      "required": [
        "name",
        "extension"
      ],
      "additionalProperties": false
    },
    "auth_code": {
      "type": "string",
      "minLength": 1
    },
    "owner_handle": {
      "type": "string",
      "minLength": 1
    },
    "admin_handle": {
      "type": "string"
    },
    "tech_handle": {
      "type": "string"
    },
    "billing_handle": {
      "type": "string"
    },
    "ns_group": {
      "type": "string"
    }
  },
  "required": [
    "domain",
    "auth_code",
    "owner_handle"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

restore_domain

Restore a domain from redemption (billable; requires approval).

Default mode: confirm

Input schema:

{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "exclusiveMinimum": 0
    },
    "domain": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "minLength": 1
        },
        "extension": {
          "type": "string",
          "minLength": 1
        }
      },
      "required": [
        "name",
        "extension"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}