View as Markdown
OpenSRS icon

OpenSRS ACTION

Register Domain

Register a new domain. See the documentation.
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's OpenSRS account once, then configure and run Register Domain from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "opensrs-register-domain",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    opensrs: { authProvisionId: "apn_xxxxxxx" },
    domain: "Domain",
    regUsername: "Reseller Username",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Register Domain inputs
Property Type Description
domain Domain string
The domain name to register, update, or transfer.
Required
regUsername Reseller Username string
Usernames must be 3-20 characters in length. You can use any of the following alphanumeric characters: A-Z, a-z, 0-9.
Required
regPassword Reseller Password string
Passwords must be 10-20 characters in length. You can use any of the following alphanumeric characters and symbols: A-Z, a-z, 0-9, ! @$^,.~|=-+_{}#.
Required
ownerFirstName Owner First Name string
The first name of the owner of the domain.
Required
ownerLastName Owner Last Name string
The last name of the owner of the domain.
Required
ownerEmail Owner Email string
The email of the owner of the domain.
Required
ownerOrgName Owner Organization Name string
The organization name of the owner of the domain.
Optional
ownerPhone Owner Phone string
The phone number of the owner of the domain.
Required
ownerAddress1 Owner Address 1 string
The first line of the address of the owner of the domain.
Required
ownerCity Owner City string
The city of the owner of the domain.
Required
ownerCountry Owner Country string
The country of the owner of the domain.
Required
ownerState Owner State string
The state of the owner of the domain.
Required
ownerPostalCode Owner Postal Code string
The postal code of the owner of the domain.
Required
adminFirstName Admin First Name string
The first name of the admin of the domain.
Required
adminLastName Admin Last Name string
The last name of the admin of the domain.
Required
adminEmail Admin Email string
The email of the admin of the domain.
Required
adminOrgName Admin Organization Name string
The organization name of the admin of the domain.
Optional
adminPhone Admin Phone string
The phone number of the admin of the domain.
Required
adminAddress1 Admin Address 1 string
The first line of the address of the admin of the domain.
Required
adminCity Admin City string
The city of the admin of the domain.
Required
adminCountry Admin Country string
The country of the admin of the domain.
Required
adminState Admin State string
The state of the admin of the domain.
Required
adminPostalCode Admin Postal Code string
The postal code of the admin of the domain.
Required
billingFirstName Billing First Name string
The first name of the billing contact of the domain.
Required
billingLastName Billing Last Name string
The last name of the billing contact of the domain.
Required
billingEmail Billing Email string
The email of the billing contact of the domain.
Required
billingOrgName Billing Organization Name string
The organization name of the billing contact of the domain.
Optional
billingPhone Billing Phone string
The phone number of the billing contact of the domain.
Required
billingAddress1 Billing Address 1 string
The first line of the address of the billing contact of the domain.
Required
billingCity Billing City string
The city of the billing contact of the domain.
Required
billingCountry Billing Country string
The country of the billing contact of the domain.
Required
billingState Billing State string
The state of the billing contact of the domain.
Required
billingPostalCode Billing Postal Code string
The postal code of the billing contact of the domain.
Required
techFirstName Tech First Name string
The first name of the tech contact of the domain.
Required
techLastName Tech Last Name string
The last name of the tech contact of the domain.
Required
techEmail Tech Email string
The email of the tech contact of the domain.
Required
techOrgName Tech Organization Name string
The organization name of the tech contact of the domain.
Optional
techPhone Tech Phone string
The phone number of the tech contact of the domain.
Required
techAddress1 Tech Address 1 string
The first line of the address of the tech contact of the domain.
Required
techCity Tech City string
The city of the tech contact of the domain.
Required
techCountry Tech Country string
The country of the tech contact of the domain.
Required
techState Tech State string
The state of the tech contact of the domain.
Required
techPostalCode Tech Postal Code string
The postal code of the tech contact of the domain.
Required
customTechContact Custom Tech Contact string
An indication of whether to use the RSP's tech contact info, or the tech contact info provided n the request.
Required
autoRenew Auto Renew string
Whether to automatically renew the domain.
Optional
period Period string
The length of the registration period. Allowed values are 1-10, depending on the TLD, that is, not all registries allow for a 1-year registration. The default is 2, which is valid for all TLDs.
Required
customNameservers Custom Nameservers string
Custom nameservers for the domain.
Required
jsonOutput JSON Output boolean
Whether to output the response in JSON format.
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
opensrs-register-domain
Version
0.0.2
App
OpenSRS
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes