20i-api 2022.10.18.155209

.NET 6.0

dotnet add package 20i-api --version 2022.10.18.155209

NuGet\Install-Package 20i-api -Version 2022.10.18.155209

This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.

<PackageReference Include="20i-api" Version="2022.10.18.155209" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

paket add 20i-api --version 2022.10.18.155209

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: 20i-api, 2022.10.18.155209"

#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.

// Install 20i-api as a Cake Addin
#addin nuget:?package=20i-api&version=2022.10.18.155209

// Install 20i-api as a Cake Tool
#tool nuget:?package=20i-api&version=2022.10.18.155209

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

20i API dotnet libary

Get started with 3 steps

Install Nuget package

dotnet add package 20i-api

Create new instance of 20i API

var api = new TwentyIApi(bearer,new HttpClient());

Use the API

var packages = await api.Package();

Note <i>You can inject your own HttpClient to use your own implementation of HttpClient or an injected client from a factory.</i>

Official API Documentation

Methods

TwentyIApi

TwentyIApi `type`

Namespace

TwentyI_dotnet

Summary

Library entry class

#ctor(bearer,client) `constructor`

Summary

Constructor, will be used to set the bearer token and the http client

Parameters

Name	Type	Description
bearer	System.String	Bearer token, the General API key provided by 20i
client	System.Net.Http.HttpClient	Http client

GetDomainPeriods() `method`

Summary

List all possible domains that are supported with the periods that are supported for registration

Returns

The raw json response as a string

Parameters

This method has no parameters.

GetDomainPremiumTypes() `method`

Summary

List all domain extentions with their associated premium group.

Returns

The raw json response as a string

Parameters

This method has no parameters.

GetDomainSearch(query) `method`

Summary

Searches for one or more domain names. If you provide a domain name, this will search for that name only, otherwise it will search for that prefix on all supported TLDs. You may supply multiple literal domain names if you separate them with commas. You may supply arbitrary text, which will be stripped down to something suitable for domain search. This is typically useful with suggestions on. Under some circumstances this will attempt a detailed search, which will fetch more specific information about transferrable domains. This will happen if you search for one domain name. Domain Suggestions Our primary domain availability provider supports suggesting names based on the search, using simple semantic permutations of the supplied name(s). For example if you're searching for mailboxdelivery.com it might suggest post-delivery.com, mailboxsend.net and my-mailbox-delivery.com. These are supported only in a small set of TLDs (including .com, .net, .org, .info). These names are probably available, and will get properly checked at the end of the results, meaning that you will get two results: one marked "suggestion" and a later one which looks like a direct domain search result. At the current time, setting the TLDs to search is not supported. If a domain is returned which you aren't set up to sell, you should exclude it from your view. Note on responsiveness and order All results will be output at the earliest possible opportunity, and will be delivered in separate packets with each result hash on a line on its own. This means that the order will usually be different to the header order, and the output will look a little different to typical JSON responses. Usage limits Access to this service is subject to reasonable usage limits. If you go over the limit, further access will be blocked for up to 24 hours.

Returns

The raw json response as a string

Parameters

Name	Type	Description
query	System.String	The query to search for

GetDomains() `method`

Summary

RetrieveDomains Returns basic information about the domains in the account.

Returns

The raw json response as a string

Parameters

This method has no parameters.

GetManagedVps(id) `method`

Summary

Returns an object representation of your managed VPS.

Returns

The raw json response as a string

Parameters

Name	Type	Description
id	System.String	The id of the managed vps

GetManagedVpsList() `method`

Summary

Returns a short, cheap set of info for all managed VPSs.

Returns

The raw json response as a string

Parameters

This method has no parameters.

GetManagedVpsName(id) `method`

Summary

Returns the name of one Managed VPS.

Returns

The raw json response as a string

Parameters

Name	Type	Description
id	System.String	The id of the managed vps

GetManagedVpsPackageCount(id) `method`

Summary

Returns the count of how many packages can be created on this managed VPS.

Returns

The raw json response as a string

Parameters

Name	Type	Description
id	System.String	The id of the managed vps

GetMssql() `method`

Summary

Retrieve MSSQL Databases

Returns

The raw json response as a string

Parameters

This method has no parameters.

GetMssqlById(id) `method`

Summary

Retrieve MSSQL Database by ID

Returns

The raw json response as a string

Parameters

Name	Type	Description
id	System.String	The id of the mssql database

ManagedVpsAddWeb(id,body) `method`

Summary

Add a web site.

Returns

The raw json response as a string

Parameters

Name	Type	Description
id	System.String	The id of the managed vps
body	System.String	The json body to send

Remarks

Json sample body: { domain_name: "string", extra_domain_names: "string" }

ManagedVpsDeleteWeb(id,body) `method`

Summary

Delete web sites.

Returns

The raw json response as a string

Parameters

Name	Type	Description
id	System.String	The id of the managed vps
body	System.String	The json body to send

Remarks

Json sample body: { delete-id: ["string"] }

ManagedVpsSetName(id,body) `method`

Summary

Set the VPS Name

Returns

The raw json response as a string

Parameters

Name	Type	Description
id	System.String	The id of the managed vps
body	System.String	The json body to send

Remarks

Json sample body: { name: "string" }

MssqlLinkPackage(id,body) `method`

Summary

Update the config to link the MS SQL product to a package.

Returns

The raw json response as a string

Parameters

Name	Type	Description
id	System.String	The id of the mssql database
body	System.String	The json body to send

Remarks

Json sample body: { id:1 }

Package() `method`

Summary

Returns information about this service.

Returns

The raw json response as a string

Parameters

This method has no parameters.

Package(packageId) `method`

Summary

Returns an array representation of the package.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package

PackageBundleTypeLimits(packageId) `method`

Summary

Returns the limits set of this package bundle type.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package

PackageDatabaseUser(packageId,databaseId,userId) `method`

Summary

Returns some information about the database user

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
databaseId	System.String	The id of the database
userId	System.String	The id of the user

PackageDefaultDns(packageId) `method`

Summary

Returns the default DNS records from the web object.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package

PackageDomain(packageId,domainId) `method`

Summary

Returns information about the domain.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
domainId	System.String	The id of the domain

PackageDomainAuthcode(packageId,domainId) `method`

Summary

Returns the domain's EPP auth code, as needed for outbound transfers in some circumstances. This MAY issue a new authcode, so it's not suitable to call if you're caching an older copy of the authcode, and it's inadvisable to access this while a transfer is in progress.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
domainId	System.String	The id of the domain

PackageDomainCanTransfer(packageId,domainId) `method`

Summary

Get the flag allowing or disallowing transfers.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
domainId	System.String	The id of the domain

PackageDomainCanTransfer(packageId,domainId,body) `method`

Summary

Set the flag allowing or disallowing transfers, aka the "domain lock".

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
domainId	System.String	The id of the domain
body	System.String	The body of the request

Remarks

body: {enabled:true}

PackageDomainCancelTransfer(packageId,domainId) `method`

Summary

Cancel an incoming transfer. If successful, this will also refund to balance.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
domainId	System.String	The id of the domain

PackageDomainContacts(packageId,domainId) `method`

Summary

Returns the current contacts for the domain name. This is a map of contact types to contact data, in EPP format.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
domainId	System.String	The id of the domain

PackageDomainContacts(packageId,domainId,body) `method`

Summary

Sets the contacts for the domain. This is a map of contact types to contact data, in EPP format.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
domainId	System.String	The id of the domain
body	System.String	The body of the request

Remarks

sample body: { contacts: { "string": "string" } }

PackageDomainDns(packageId,domainId) `method`

Summary

Returns the current DNS records for the domain.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
domainId	System.String	The id of the domain

PackageDomainDnsGoogleApps(packageId,domainId) `method`

Summary

Returns the records needed for a full Google Apps service, including mail and web services. You can send these back in the "new" key when updating DNS to add them, but it's recommended that you also delete any conflicting records at the same time.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
domainId	System.String	The id of the domain

PackageDomainDnsGoogleApps(packageId,domainId,body) `method`

Summary

Equivalent to adding new DNS records with all the results of GET "googleApps". This will not remove any records by default.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
domainId	System.String	The id of the domain
body	System.Object	The body of the request

Remarks

sample body: { conflictPolicy: "string" }

PackageDomainDnsGoogleAppsMailOnly(packageId,domainId) `method`

Summary

Returns the records needed for Google Mail service. You can send these back in the "new" key when updating DNS to add them, but it's recommended that you also delete any conflicting records at the same time.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
domainId	System.String	The id of the domain

PackageDomainDnsGoogleAppsMailOnly(packageId,domainId,body) `method`

Summary

Equivalent to adding new DNS records with all the results of GET "googleAppsMailOnly". This will not remove any records by default.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
domainId	System.String	The id of the domain
body	System.Object	The body of the request

Remarks

sample body: { conflictPolicy: "string" }

PackageDomainDnsOffice365Mail(packageId,domainId) `method`

Summary

Returns the records needed for office 365 mail.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
domainId	System.String	The id of the domain

PackageDomainDnsOffice365MailOnly(packageId,domainId,body) `method`

Summary

Equivalent to adding new DNS records with all the results of GET "Office365MailOnly". This will not remove any records by default.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
domainId	System.String	The id of the domain
body	System.Object	The body of the request

Remarks

sample body: { conflictPolicy:"string" }

PackageDomainDnsUpdate(packageId,domainId,body) `method`

Summary

Updates the DNS records for the domain, if the DNS service is in use. Name prefixes are either plain names like "www" or "mail", or "@" to indicate that it applies to the domain itself (typically only AAAA, A or MX). NOTE: The platform may silently rewrite some adds into updates. NOTE: CNAMEs are special records (see RFC1034, with reference to RFC1912): they actually mean "no stop you're looking in the wrong place, ask instead for ". Thus on any name you can only have one of: (a)no records, (b) 1 CNAME, or (c) 1+ non-CNAME records (including SOA and NS). If you have a CNAME on a name and want to add records on that name, you should remove the CNAME (this may be done implicitly for you). If you have non-CNAME records on a name and want to add a CNAME on that name, you will have to delete every non-CNAME record on the name. In most cases, people using CNAME actually want "A/AAAA CNAME", ie. aliasing the A and AAAA records but nothing else (which the DNS protocol doesn't support). The distinction doesn't affect anything unless you have conflicting records on the same name, which usually is only the case for the root. Since browsers do not support _http._tcp SRV records (and don't intend to), you simply have to manually copy A or AAAA records in this case.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
domainId	System.String	The id of the domain
body	System.String	The body of the request

Remarks

{ conflictPolicy: "string", insertPolicy: "string", new:{ AAAA:{ host: "string", ipv6: "string", }, A:{ host: "string", ip: "string", }, CNAME:{ reuseId: "string", host: "string", target: "string", }, MX:{ host: "string", target: "string", pri: "string", }, TXT:{ host: "string", txt: "string", }, SRV:{ host: "string", pri: "string", weight: "string", port: "string", target: "string", } }, delete: ["string"] }

PackageDomainLabels(packageId,domainId,body) `method`

Summary

Add or Remove a label for this domain

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
domainId	System.String	The id of the domain
body	System.String	The raw json body

Remarks

sample body: { label: "string", type: "string" }

PackageDomainLimits(packageId,domainId) `method`

Summary

Returns the limits for the current user, a key-value map.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
domainId	System.String	The id of the domain

PackageDomainMaxNameservers(packageId,domainId) `method`

Summary

Returns the maximum number of nameservers for the domain. You can and should cache this information by TLD.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
domainId	System.String	The id of the domain

PackageDomainNameservers(packageId,domainId) `method`

Summary

Returns the current nameservers for the domain, if applicable.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
domainId	System.String	The id of the domain

PackageDomainNameservers(packageId,domainId,body) `method`

Summary

Updates the nameservers for the domain. If the old nameservers do not match, the registry may reject the request. Some registries may handle names which are present in both "ns" and "old-ns" incorrectly, so it's recommended that you do not include names which are being kept.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
domainId	System.String	The id of the domain
body	System.Object	The body of the request

Remarks

sample body: { ns: ["string"], old-ns: ["string"] }

PackageDomainOptOut(packageId,domainId) `method`

Summary

Fetches information about WHOIS contact disclosure (Nominet or .IT) for the domain name.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
domainId	System.String	The id of the domain

PackageDomainOptOut(packageId,domainId,body) `method`

Summary

Updates the WHOIS disclosure options, for applicable domains.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
domainId	System.String	The id of the domain
body	System.String	The body of the request

Remarks

sample body: { enabled: true }

PackageDomainPendingTransfer(packageId,domainId) `method`

Summary

Returns true if this domain is waiting for transfer completion.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
domainId	System.String	The id of the domain

PackageDomainPendingTransferStatus(packageId,domainId) `method`

Summary

Returns the current cached status of the transfer.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
domainId	System.String	The id of the domain

PackageDomainPrivacy(packageId,domainId) `method`

Summary

Returns information about the service domain privacy.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
domainId	System.String	The id of the domain

PackageDomainPrivacy(packageId,domainId,body) `method`

Summary

Update the privacy settings for the service domain.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
domainId	System.String	The id of the domain
body	System.String	The body of the request

Remarks

sample body: { emailDestination: "string" }

PackageDomainPrivacyState(packageId,domainId,body) `method`

Summary

Updates the privacy enabled/disabled state (for domains with privacy attached only).

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
domainId	System.String	The id of the domain
body	System.String	The body of the request

Remarks

sample body: { enabled: true }

PackageDomainRenewalMultipleMaxHintFor(packageId,domainId) `method`

Summary

Will provide a hint on what the current maximum years would be allowed for a renewal

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
domainId	System.String	The id of the domain

PackageDomainResendVerificationEmail(packageId,domainId,body) `method`

Summary

Resend the registrant verification email, if one applies.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
domainId	System.String	The id of the domain
body	System.String	The body of the request

Remarks

body: { }

PackageDomainServicePrice(packageId,domainId) `method`

Summary

Get a per-year price, if premium, specifically for renewals. This is always in GBP; it will require currency conversion for other currencies and may or may not have markup added for checkout.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
domainId	System.String	The id of the domain

PackageDomainSessionlimits(packageId,domainId) `method`

Summary

Returns the limits for the session. If the user is a super user then they are exempt from explicit limit restrictions.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
domainId	System.String	The id of the domain

PackageDomainTag(packageId,domainId) `method`

Summary

Change the IPS-tag for a domain. Applicable to UK domains only. If this operation succeeds, the domain will no longer be controllable.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
domainId	System.String	The id of the domain

Remarks

body: {new-tag:"string"}

PackageDomainTransferInfo(packageId,domainId) `method`

Summary

Returns information about the pending transfer (if any).

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
domainId	System.String	The id of the domain

PackageDomainUpdateTransfer(packageId,domainId,body) `method`

Summary

Modify an incoming transfer.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
domainId	System.String	The id of the domain
body	System.String	The body of the request

Remarks

body: { action: "string", authInfo:{ pw: "string" }, configuration:{ } }

PackageDomainUpstreamExpiryDate(packageId,domainId) `method`

Summary

Returns the expiry date at the registry. This does not necessarily indicate the payment status of the domain nor does it reflect when renewal will occur. It is possible for this to return null, eg. for an incomplete transfer or a deleted domain.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
domainId	System.String	The id of the domain

PackageDomainUserStatus(packageId,domainId,body) `method`

Summary

Activates or deactivates the service. Possible subservice_name are 'default' for a typical set of services and 'main' for the core service only.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
domainId	System.String	The id of the domain
body	System.String	The json body to send

Remarks

Json sample body: { includeRepeated: true, subservices:{ (subservice_name): true } }

PackageDomainWhois(packageId,domainId) `method`

Summary

Returns the current live WHOIS text for the domain. Only works for domains registered with 20i.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
domainId	System.String	The id of the domain

PackageEmail(packageId,mailId) `method`

Summary

Returns the current email configuration for the domain. This is a map of setting types to arrays of settings, in the same format as the "email" method but with an extra "id" property on each item. To facilitate page display, this also redundantly includes the domain name in a "name" property.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
mailId	System.String	The id of the mail

PackageEmail(packageId,mailId,body) `method`

Summary

Updates the email configuration for the domain.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
mailId	System.String	The id of the mail
body	System.String	The body of the request

Remarks

sample body:{ { result:{ }, name: "string" } }

PackageEmailAllMailForwarders(packageId) `method`

Summary

Fetches all forwarders by package id.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package

PackageEmailDomain(packageId,mailId) `method`

Summary

Returns the current domain config.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
mailId	System.String	The id of the mail

PackageEmailDomainAlias(packageId,mailId) `method`

Summary

Returns the current domain alias config.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
mailId	System.String	The id of the mail

PackageEmailForwarder(packageId,mailId) `method`

Summary

Returns the current forwarder config.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
mailId	System.String	The id of the mail

PackageEmailMailForwarder(packageId,mailId) `method`

Summary

Returns the current mailbox forwarder config.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
mailId	System.String	The id of the mail

PackageEmailMailbox(packageId,mailId) `method`

Summary

Returns the current mailbox config.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
mailId	System.String	The id of the mail

PackageEmailResponder(packageId,emailId) `method`

Summary

Returns the current autoresponder config.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
emailId	System.String	The id of the email

PackageEmailSignature(packageId,emailId) `method`

Summary

Returns domain DKIM Signatures.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
emailId	System.String	The id of the email

PackageEmailSignature(packageId,emailId,body) `method`

Summary

Set or Delete DKIM Signature for a given domain.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
emailId	System.String	The id of the email
body	System.String	The body of the request

Remarks

sample body: { action: "string", body:{ Canonicalization: "string", ExpiryTime: 1, Flag: "string", Granularity: "string", IsDefault: true, IsStrict: true, Note: "string", Selector: "string", ServiceType: "string" } }

PackageEmailSpamPolicyListBlacklist(packageId,mailId) `method`

Summary

Returns the current blacklist config - email.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
mailId	System.String	The id of the mail

PackageEmailSpamPolicyListWhitelist(packageId,mailId) `method`

Summary

Returns the current whitelist config.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
mailId	System.String	The id of the mail

PackageEmailWebmail(packageId,mailId,body) `method`

Summary

Generate a webmail single-sign-on URL

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
mailId	System.String	The id of the mail
body	System.String	The body of the request

Remarks

body: { id: "string" }

PackageLimits(packageId) `method`

Summary

Returns the limits for the current user, a key-value map.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package

PackageNames(packageId) `method`

Summary

Returns the names for this package.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package

PackageNames(packageId,body) `method`

Summary

Add or remove names from the package. This has special behaviour if any of the names are also registered (renewable) domain names in your account: As a policy matter, you may not remove the last name from the object. If you attempt to do so, you will get an error.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
body	System.String	The body of the request

Remarks

sample body: { add: ["string"], rem: ["string"], chg: "string" }

PackageSendWelcome(packageId,body) `method`

Summary

Sends or re-sends the welcome email if a contact is found for a provided toAddress then it will be sent to the template data and be available in twig

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
body	System.String	The body of the request

Remarks

body: { toAddress: "string" }

PackageSessionlimits(packageId) `method`

Summary

Returns the limits for the session. If the user is a super user then they are exempt from explicit limit restrictions.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package

PackageStackUserList(packageId) `method`

Summary

Retrieve stack user list.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package

PackageUserStatus(packageId,body) `method`

Summary

Activates or deactivates the service. Possible subservice_name are 'default' for a typical set of services and 'main' for the core service only.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
body	System.String	The json body to send

Remarks

Json sample body: { includeRepeated: true, subservices:{ (subservice_name): true } }

PackageWeb(packageId) `method`

Summary

Returns detailed information about the package.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package

PackageWebAllowedPhpConfiguration(packageId) `method`

Summary

Get allowed PHP configuration directives.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package

PackageWebAvailablePhpVersions(packageId) `method`

Summary

Get all available PHP versions.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package

PackageWebBandwidthStats(packageId) `method`

Summary

Get the bandwidth stats and hits.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package

PackageWebBlockedCountries(packageId) `method`

Summary

Get blocked countries, in the format of 2-digit ISO codes.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package

PackageWebBlockedCountries(packageId,body) `method`

Summary

Set the blocked countries for the site.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
body	System.String	The body of the request

Remarks

sample body: {countries: ["string"] }

PackageWebBlockedIpAddresses(packageId) `method`

Summary

Get blocked IP addresses either in standard format or in CIDR format.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package

PackageWebBlockedIpAddresses(packageId,body) `method`

Summary

Set the blocked IP addresses for the web|package. This is an array of IP addresses, with an optional CIDR range.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
body	System.String	The body of the request

Remarks

sample body: { ip_addresses: ["string"] }

PackageWebCdnStats(packageId) `method`

Summary

Returns the CDN statistics for the package.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package

PackageWebCdnStatsTrafficDistribution(packageId) `method`

Summary

Shows bandwidth and hits split by country as recorded by our edge CDN platform

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package

PackageWebCertificates(packageId) `method`

Summary

Gets an array of all the certificates attached to virtual hosts on this web. Both free and external SSLs will be retreived.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package

PackageWebCertificatesUpdate(packageId,body) `method`

Summary

Remove or update certificates from the Web. Currently only remove is supported.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
body	System.String	The raw json body

Remarks

sample body: { delete: ["string"] }

PackageWebDatabase(packageId,databaseId) `method`

Summary

Returns some information about the database.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
databaseId	System.String	The id of the database

PackageWebDirectoryIndex(packageId) `method`

Summary

Retrieve directory listing configuration.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package

PackageWebDirectoryIndex(packageId,body) `method`

Summary

Set up to 5 files for the directory index in the htaccess.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
body	System.String	The body of the request

Remarks

sample body: { directoryIndex: ["string"] }

PackageWebDirectoryIndexing(packageId) `method`

Summary

Get the directory indexing state

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package

PackageWebDirectoryIndexing(packageId,body) `method`

Summary

Directory indexing allows visitors to view a list of files instead of the actual webpage. This can turn on/off directory indexing for the website

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
body	System.String	The body of the request

Remarks

sample body: { value: true }

PackageWebDiskUsage(packageId,body) `method`

Summary

Get report details for Web disk usage.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
body	System.String	The body of the request

Remarks

body: { reportId:"string" }

PackageWebDocumentRoots(packageId) `method`

Summary

Returns a map of DNS names to document root subpaths for the site.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package

PackageWebDomainCheck(packageId,body) `method`

Summary

Get details about a given domain, ie is this a domain or subdomain.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
body	System.String	The body of the request

Remarks

sample body: { domain: "string" }

PackageWebExternalSsl(packageId,body) `method`

Summary

Install an external SSL certificate.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
body	System.String	The raw json body

Remarks

sample body: { name: "string", certificate: "string", key: "string", ca: "string" }

PackageWebFilePermissions(packageId) `method`

Summary

Get the file permissions that do not match the platform recommendations

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package

PackageWebFilePermissions(packageId,body) `method`

Summary

Set file permissions

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
body	System.String	The body of the request

Remarks

sample body: { permissionCheckId: 1, files:{ file: "string", perms: 1 } }

PackageWebForceSsl(packageId) `method`

Summary

Returns whether the site has forced SSL.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package

PackageWebForceSsl(packageId,body) `method`

Summary

Sets the Force SSL flag for a site.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
body	System.String	The raw json body

Remarks

sample body: { value: true }

PackageWebFreeSsl(packageId,body) `method`

Summary

This will toggle the free SSL for a web name. The lower level platform handles nameserver checks.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
body	System.String	The raw json body

Remarks

sample body: { name: "string", enabled: true }

PackageWebFtpCredentials(packageId) `method`

Summary

Returns the FTP credentials (if any).

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package

PackageWebFtpUsers(packageId) `method`

Summary

Returns an array of FTP users for this ExternalId and the Acl associated with the FTP account

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package

PackageWebFtpUsers(packageId,body) `method`

Summary

Update or create a new FTP user. This method will handle the creation of new FTP users and updating existing FTP users.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
body	System.String	The body of the request

Remarks

sample body: { new:{ ftp:{ user:{ Username: "string", Domain: "string", Password: "string", JailFrom: "string" } } }, update:{ ftp:{ id: "string", user:{ Password: "string", JailFrom: "string", UnlockedUntil: "string", Enabled: true }, acl: "string" } }, delete:{ ftp:{ id: ["string"] } } }

PackageWebHomeDirectory(packageId) `method`

Summary

Returns the home directory for the web site.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package

PackageWebInstalledApplications(packageId) `method`

Summary

Return a list of installed applications

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package

PackageWebInstalledApplications(packageId,body) `method`

Summary

Add, remove and update applications and set their environment Currently only one type (add,update,delete,setEnv) is supported per request.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
body	System.String	The json body to send

Remarks

json sample { add:{ domain: "string", environment: "string", name: "string", path: "string", script: "string", typeCode: "string" }, update:{ domain: "string", environment: "string", name: "string", path: "string", script: "string", typeCode: "string" }, delete:{ id: "string" }, setEnv:{ id: "string", environment: "string" } }

PackageWebInstalledSoftware(packageId) `method`

Summary

Returns a list of installed software by type code on managed server.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package

PackageWebLimits(packageId) `method`

Summary

Retrieve limits for a web.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package

PackageWebLogs(packageId) `method`

Summary

Get access and error logs for the site.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package

PackageWebMaintenanceMode(packageId) `method`

Summary

Get maintenance mode settings for this web.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package

PackageWebMaintenanceMode(packageId,body) `method`

Summary

Set maintenance mode settings for this web.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
body	System.String	The raw json body

Remarks

sample body: {"enabled":true}

PackageWebMalwareReport(packageId) `method`

Summary

Returns the latest malware report for a given website

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package

PackageWebMalwareScan(packageId) `method`

Summary

Get the malware scan objects for this web

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package

PackageWebMalwareScan(packageId,body) `method`

Summary

Set Mailware Scan lock state, setting to "new" will request a new scan

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
body	System.String	The raw json body

Remarks

sample body: {"LockState":"new"}

PackageWebMssqlDatabases(packageId) `method`

Summary

Get MSSQL Databases.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package

PackageWebMssqlDatabases(packageId,body) `method`

Summary

Create a new MSSQL Database and a user with the same name.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
body	System.String	The raw json body

Remarks

sample body: { name: "string",password: "string" }

PackageWebMssqlUserPassword(packageId,body) `method`

Summary

Update the password for an MSSQL user.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
body	System.String	The raw json body

Remarks

sample body: { databaseId: 1, userId: 1, password: "string" }

PackageWebMssqlUsers(packageId,body) `method`

Summary

Add a user to an MSSQL database.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
body	System.String	The raw json body

Remarks

sample body: { databaseId: 1, username: "string", password: "string" }

PackageWebMysqlDatabase(packageId,body) `method`

Summary

Create a MySQL database.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
body	System.String	The raw json body

Remarks

sample body: { name: "string", password: "string", allow_random: true }

PackageWebMysqlDatabases(packageId) `method`

Summary

Get all MySQL databases.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package

PackageWebMysqlGrantUserDatabase(packageId,body) `method`

Summary

Grant an existing user the default privileges on a database.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
body	System.String	The raw json body

Remarks

sample body: { username: "string", database: "string" }

PackageWebMysqlGrants(packageId) `method`

Summary

Get the grants for MySQL users and databases.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package

PackageWebMysqlGrants(packageId,body) `method`

Summary

Update the grants for MySQL users and databases.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
body	System.String	The raw json body

Remarks

sample body: { user_id: "string", username: "string", database: "string", grants: ["string"] }

PackageWebMysqlSso(packageId) `method`

Summary

Get a list of each MySQL database server and a Single Sign on link for each.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package

PackageWebMysqlUserIpAcl(packageId) `method`

Summary

Get the external IP addresses that MySQL users are allowed to connect to remotely.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package

PackageWebMysqlUserIpAcl(packageId,body) `method`

Summary

Update the external IP addresses that MySQL users are allowed to connect to remotely.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
body	System.String	The raw json body

Remarks

sample body: { add:{ user_id: 1, hosts: "string" }, remove:{ user_id: 1, id: 1 } }

PackageWebMysqlUserPassword(packageId,body) `method`

Summary

Update a MySQL user's password.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
body	System.String	The raw json body

Remarks

sample body: { user_id: 1, password: "string" }

PackageWebMysqlUsers(packageId) `method`

Summary

Get all mysql users.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package

PackageWebMysqlUsers(packageId,body) `method`

Summary

Create a new mysql user.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
body	System.String	The raw json body

Remarks

sample body: { username: "string", password: "string", database: "string" }

PackageWebNames(packageId,body) `method`

Summary

Add or remove names from the Web. This is mostly handled on the corresponding Package.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
body	System.String	The body of the request

Remarks

sample body: { add: ["string"], rem: ["string"], chg: "string" }

PackageWebOneclick(packageId) `method`

Summary

Returns an array for One Click objects that contain details of the current version and details in use

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package

PackageWebOneclick(packageId,body) `method`

Summary

Install a One Click package.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
body	System.String	The raw json body

Remarks

sample body: { domain: "string", httpsDomain: "string", oneclick: "string", directory: "string", licenceKey: "string" }

PackageWebPasswordProtection(packageId) `method`

Summary

Get the password protected directories.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package

PackageWebPasswordProtection(packageId,body) `method`

Summary

Set the password protected directories

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
body	System.String	The raw json body

Remarks

sample body: { directories:{ directory: "string", username: "string", password: "string" } }

PackageWebPhpConfig(packageId,phpConfigId) `method`

Summary

Returns the PHP config for a name.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
phpConfigId	System.String	The id of the php config

PackageWebPhpConfigUpdateConfig(packageId,phpConfigId,body) `method`

Summary

Update the PHP configuration for a name.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
phpConfigId	System.String	The id of the php config
body	System.String	The raw json body

Remarks

sample body: { config:{ (key): "string" } }

PackageWebPhpVersion(packageId) `method`

Summary

Get the PHP version for the site.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package

PackageWebPhpVersion(packageId,body) `method`

Summary

Set the PHP version for the site.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
body	System.String	The raw json body

Remarks

sample body: { value:"string"}

PackageWebPreventHotlinking(packageId) `method`

Summary

Get the prevent hotlinking config.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package

PackageWebPreventHotlinking(packageId,body) `method`

Summary

Set the prevent hotlinking config.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
body	System.String	The body of the request

Remarks

sample body: { AllowDirect: true, AllowedHostnames: ["string"], RedirectURL: "string", Extensions: ["string"] }

PackageWebRecycleApplicationPool(packageId) `method`

Summary

Recycle a Windows application pool.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package

Remarks

body: { }

PackageWebRedirects(packageId) `method`

Summary

Returns a list of redirects for the site.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package

PackageWebRedirects(packageId,body) `method`

Summary

Set the website redirects.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
body	System.String	The raw json body

Remarks

sample body:{ redirects:{ domain: "string", from: "string", to: "string", type: "string" } }

PackageWebReinstall(packageId) `method`

Summary

Re-install from platform. This will re-install software in the hosting space. EG wordpress package types will re-install wordpress

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package

PackageWebRemoveMssqlDatabase(packageId,body) `method`

Summary

Remove an MSSQL database.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
body	System.String	The raw json body

Remarks

sample body: { id: 1 }

PackageWebRemoveMssqlUser(packageId,body) `method`

Summary

Remove an MSSQL user.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
body	System.String	The raw json body

Remarks

sample body: { databaseId: 1, userId: 1 }

PackageWebRemoveMysqlDatabase(packageId,body) `method`

Summary

Remove a MySQL database.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
body	System.String	The raw json body

Remarks

sample body: { id: 1 }

PackageWebRemoveMysqlUser(packageId,body) `method`

Summary

Remove a MySQL user.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
body	System.String	The raw json body

Remarks

sample body: { id: 1 }

PackageWebRequestDiskUsage(packageId,body) `method`

Summary

Request Disk Usage Report

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
body	System.String	The body of the request

Remarks

sample body: { subdirectory: "string" }

PackageWebRestoreWebsiteBackup(packageId,body) `method`

Summary

Restore a backup file which has been uploaded via FTP

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
body	System.String	The raw json body

Remarks

sample body: { filename: "string", restore_type: "string", restore_databases: true }

PackageWebSitemap(packageId) `method`

Summary

Get the sitemap jobs, only returls a single jobs (last returned from platform)

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package

PackageWebSitemapStart(packageId) `method`

Summary

Start a sitemap job.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package

Remarks

sample body: { }

PackageWebSshAuthenticator(packageId,body) `method`

Summary

Set ssh authenticator status.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
body	System.String	The raw json body

Remarks

sample body: { status:"string" }

PackageWebSshKeys(packageId) `method`

Summary

Get a list of SSH keys for this package.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package

PackageWebSshKeysUpdate(packageId,body) `method`

Summary

Update or add new SSH keys.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
body	System.String	The raw json body

Remarks

sample body: { add:{ key: "string", handle: "string" }, delete: ["string"] }

PackageWebSshPassword(packageId) `method`

Summary

Get the SSH password for this package.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package

PackageWebSshPasswordUpdate(packageId,body) `method`

Summary

Set the SSH password for this package.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
body	System.String	The raw json body

Remarks

sample body: { password: "string" }

PackageWebStackCache(packageId) `method`

Summary

Get stack cache settings

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package

PackageWebStackCache(packageId,body) `method`

Summary

Create or update stack cache settings

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
body	System.String	The raw json body

Remarks

sample body: { css: "string", images: "string", javascript: "string" }

PackageWebSubdomains(packageId) `method`

Summary

Returns the list of subdomain names mapped to their document roots.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package

PackageWebSubdomains(packageId,body) `method`

Summary

This does the same as POSTing to /names except that it enforces the subdomain limit and disallows non-subdomains.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
body	System.String	The raw json body

Remarks

sample body: { add: ["string"], rem: ["string"] }

PackageWebTasks(packageId) `method`

Summary

Returns an array of currently configured cron tasks.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package

PackageWebTasks(packageId,body) `method`

Summary

Update, create or delete cron task.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
body	System.String	The raw json body

Remarks

sample body: { new:{ task:{ Enabled: true, MailTo: "string", TimeSpec: "string", Command: "string" } }, delete:{ task:{ id: ["string"] } }, update:{ task:{ id: "string", Enabled: true, MailTo: "string", TimeSpec: "string", Command: "string" } } }

PackageWebTestCronTask(packageId,body) `method`

Summary

Test a cron task.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
body	System.String	The raw json body

Remarks

sample body: { task:"string" }

PackageWebUsage(packageId) `method`

Summary

Get the bandwidth and disk usage stats for the current package

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package

PackageWebWebsiteBuilderSso(packageId) `method`

Summary

Returns the Website Builder SSO link.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package

PackageWebWindowsConfiguration(packageId) `method`

Summary

Get the existing Windows configuration.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package

PackageWebWindowsConfiguration(packageId,body) `method`

Summary

Update the Windows application pool configuration. For example; the runtime version, and the pipeline mode type.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
body	System.String	The body of the request

Remarks

sample body: { ApplicationPoolPipelineMode: "string", ApplicationPoolRuntimeVersion: "string" }

PackageWebWordpressAdministrators(packageId) `method`

Summary

Get the WordPress administrator users.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package

PackageWebWordpressChecksum(packageId) `method`

Summary

Get a checksum report of WordPress core files.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package

PackageWebWordpressChecksum(packageId,body) `method`

Summary

Ask the platform to fix any checksum issues

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
body	System.String	The body of the request

Remarks

sample body: { }

PackageWebWordpressDbCheck(packageId) `method`

Summary

Returns a boolean denoting the result of the wordpress database check.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package

PackageWebWordpressInstallStackCache(packageId,body) `method`

Summary

Install the StackCache plugin for this package.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
body	System.String	The body of the request

Remarks

sample body: { }

PackageWebWordpressIsInstalled(packageId) `method`

Summary

Checks whether or not WordPress is currently installed.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package

PackageWebWordpressPlugins(packageId) `method`

Summary

Returns an array of Installed wordpress plugins.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package

PackageWebWordpressPlugins(packageId,body) `method`

Summary

Set status or remove a WordPress plugin.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
body	System.String	The body of the request

Remarks

sample body: { type: "string", name: "string" }

PackageWebWordpressRoles(packageId) `method`

Summary

Get the WordPress roles.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package

PackageWebWordpressSearchReplace(packageId,body) `method`

Summary

Perform a WordPress search and replace.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
body	System.String	The body of the request

Remarks

body { search: "string", replace: "string" }

PackageWebWordpressSettings(packageId) `method`

Summary

Get the WordPress site settings

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package

PackageWebWordpressSettings(packageId,body) `method`

Summary

Set a WordPress site setting

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
body	System.String	The body of the request

Remarks

sample body: { option_name: "string", option_value: "string" }

PackageWebWordpressStaging(packageId) `method`

Summary

Returns a result based on whether the staging version is in place.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package

PackageWebWordpressStaging(packageId,body) `method`

Summary

Clone a new WordPress site either from live to staging or from staging to live.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
body	System.String	The body of the request

Remarks

sample body: { type:"string" }

PackageWebWordpressStagingRemoveClone(packageId,body) `method`

Summary

Remove a staging clone by id

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
body	System.String	The body of the request

Remarks

sample body: { id: 1 }

PackageWebWordpressTheme(packageId,body) `method`

Summary

Set status (i.e. activate/deactivate) or remove a WordPress theme.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
body	System.String	The body of the request

Remarks

sample body: { type: "string", name: "string" }

PackageWebWordpressThemes(packageId) `method`

Summary

Returns an array of the installed WordPress themes.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package

PackageWebWordpressUpdate(packageId,body) `method`

Summary

Update WordPress to the latest version.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package
body	System.String	The body of the request

Remarks

sample body: { }

PackageWebWordpressUsers(packageId) `method`

Summary

Get Wordpress Users

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package

PackageWebWordpressVersion(packageId) `method`

Summary

Get the WordPress version if installed.

Returns

The raw json response as a string

Parameters

Name	Type	Description
packageId	System.String	The id of the package

PersonalNameserver(resellerId) `method`

Summary

List Virtual Nameservers

Returns

The raw json response as a string

Parameters

Name	Type	Description
resellerId	System.String	The id of the reseller

ResellerAddDomain(resellerId,body) `method`

Summary

Register a domain name. This will charge the appropriate registration fee to your 20i Balance. If you don't have enough left, this will fail. If you enable privacy you will also be charged a fee for the privacy service. Please note you can also just use contract#add, this method only does a simple reformatting to use that. Please see the documentation there for details.

Returns

The raw json response as a string

Parameters

Name	Type	Description
resellerId	System.String	The id of the reseller
body	System.String	The body of the request

Remarks

body: { name: "string", years: 1, caRegistryAgreement: true, contact:{ organisation: "string", name: "string", address: "string", telephone: "string", email: "string", cc: "string", pc: "string", sp: "string", city: "string", extension:{ } }, limits:{ }, otherContacts:{ (type):{ name: "string", organisation: "string", address: "string", city: "string", sp: "string", pc: "string", cc: "string", telephone: "string", email: "string", extension:{ } } }, nameservers: ["string"], privacyService: true, stackUser: "string" }

ResellerAddMssql(resellerId,body) `method`

Summary

Add an MS SQL Server allowance. This will charge the appropriate fee to your 20i Balance. If you don't have enough left, this will fail. Please note you can also use contract#add, this method only does a trivial reformatting to use that, specifically: https://prnt.sc/RDOOsJYX-nQN

Returns

The raw json response as a string

Parameters

Name	Type	Description
resellerId	System.String	The id of the reseller
body	System.String	The body of the request

ResellerAddTlsCertificate(resellerId,body) `method`

Summary

Order a TLS certificate for a site. This will charge the appropriate fee to your 20i Balance. If you don't have enough left, this will fail.

Returns

The raw json response as a string

Parameters

Name	Type	Description
resellerId	System.String	The id of the reseller
body	System.String	The body of the request

Remarks

body { periodMonths: 1, name: "string", configuration:{ } }

ResellerAddVps(resellerId,body) `method`

Summary

Order a vps

Returns

The raw json response as a string

Parameters

Name	Type	Description
resellerId	System.String	The id of the reseller
body	System.String	The body of the request

Remarks

https://prnt.sc/_6Hfr9gHcV2G body { configuration:{ ApplicationId: "string", Name: "string" }, forUser: "string", options:{ os: "string" }, periodMonths: 1, type: "string" }

ResellerAddWeb(resellerId,body) `method`

Summary

Add a web site. If a welcome email is set for the type and you pass an existing Stack user reference, the welcome email will be sent ASAP.

Returns

The raw json response as a string

Parameters

Name	Type	Description
resellerId	System.String	The id of the reseller
body	System.String	The body of the request

Remarks

body: { type: "string", domain_name: "string", extra_domain_names: ["string"], label: "string", documentRoots:{ (domain): "string" }, stackUser: "string" }

ResellerBackupBulkPackages(resellerId) `method`

Summary

Get existing multisite backups.

Returns

The raw json response as a string

Parameters

Name	Type	Description
resellerId	System.String	The id of the reseller

ResellerBackupBulkPackages(resellerId,body) `method`

Summary

Backup Multiple packages

Returns

The raw json response as a string

Parameters

Name	Type	Description
resellerId	System.String	The id of the reseller
body	System.String	The body of the request

Remarks

sample body:{ id: ["string"], delete: true }

ResellerDeleteWeb(resellerId,body) `method`

Summary

Delete the web site/packages using the array of ID's in delete-id as a list of packages to delete.

Returns

The raw json response as a string

Parameters

Name	Type	Description
resellerId	System.String	The id of the reseller
body	System.String	The body of the request

Remarks

body: { delete-id: ["string"] }

ResellerMailboxQuotaAddon(resellerId) `method`

Summary

Mailbox quota addons Returns a short, cheap list items.

Returns

The raw json response as a string

Parameters

Name	Type	Description
resellerId	System.String	The id of the reseller

ResellerNominetBrand(resellerId) `method`

Summary

Fetch your current Nominet brand settings

Returns

The raw json response as a string

Parameters

Name	Type	Description
resellerId	System.String	The id of the reseller

ResellerNominetBrand(resellerId,body) `method`

Summary

Set Nominet reseller settings

Returns

The raw json response as a string

Parameters

Name	Type	Description
resellerId	System.String	The id of the reseller
body	System.String	The body of the request

Remarks

body { nominetReseller: "string", ukResellerEmail: "string", ukResellerTradingName: "string", ukResellerUrl: "string", ukResellerVoice: "string" }

ResellerPackageCount(resellerId) `method`

Summary

Returns a count of packages split by type. Current types are linux, windows and wordpress

Returns

The raw json response as a string

Parameters

Name	Type	Description
resellerId	System.String	The id of the reseller

ResellerPackageTypeBrand(resellerId,body) `method`

Summary

Fetch the package branding.

Returns

The raw json response as a string

Parameters

Name	Type	Description
resellerId	System.String	The id of the reseller
body	System.String	The body of the request

Remarks

body: { packageid: "string" }

ResellerPackageTypes(resellerId) `method`

Summary

Get package type information.

Returns

The raw json response as a string

Parameters

Name	Type	Description
resellerId	System.String	The id of the reseller

ResellerPackageTypes(resellerId,body) `method`

Summary

Add a web type.

Returns

The raw json response as a string

Parameters

Name	Type	Description
resellerId	System.String	The id of the reseller
body	System.String	The body of the request

Remarks

body { label: "string", platform: "string", limit:{ }, installApps: ["string"], welcomeEmail:{ from: "string", subject: "string", data: "string" }, passwordResetEmail: "string", defaultPages:{ IndexPageHtml: "string", DeactivatedPageHtml: "string", ServiceUnavailablePageHtml: "string" }, extraData:{ temporaryUrlDomain: "string" } }

ResellerPasswordResetEmail(resellerId) `method`

Summary

Get the password reset email template (or the default value)

Returns

The raw json response as a string

Parameters

Name	Type	Description
resellerId	System.String	The id of the reseller

ResellerPasswordResetEmail(resellerId,body) `method`

Summary

Set the password reset email.

Returns

The raw json response as a string

Parameters

Name	Type	Description
resellerId	System.String	The id of the reseller
body	System.String	The body of the request

Remarks

sample body: { content: "string" }

ResellerRenewDomain(resellerId,body) `method`

Summary

Renew a domain name. This will charge the appropriate registration fee to your 20i Balance. If you don't have enough left, this will fail. Please note you can also use contract/domain:{id}#renew, this method only does a trivial reformatting to use that.

Returns

The raw json response as a string

Parameters

Name	Type	Description
resellerId	System.String	The id of the reseller
body	System.String	The body of the request

Remarks

body { name: "string", years: 1, renewPrivacy: true }

ResellerRenewMssql(resellerId,body) `method`

Summary

Renew the MSSQL database of the given ID This will charge the appropriate registration fee to your 20i Balance. If you don't have enough left, this will fail. Please note you can also use contract/mssql:{id}#renew, this method only does a trivial reformatting to use that.

Returns

The raw json response as a string

Parameters

Name	Type	Description
resellerId	System.String	The id of the reseller
body	System.String	The body of the request

Remarks

body { id: "string"}

ResellerRenewMssqlPre(resellerId,body) `method`

Summary

Renew an MSSQL database with the provided ID

Returns

The raw json response as a string

Parameters

Name	Type	Description
resellerId	System.String	The id of the reseller
body	System.String	The body of the request

Remarks

sample body: { id: "string" }

ResellerRenewTlsCertificate(resellerId,body) `method`

Summary

Renew a certificate. This will charge the appropriate fee to your 20i Balance. If you don't have enough left, this will fail. Please note you can also use contract/tls_certificate:{id}#renew, this method only does a trivial reformatting to use that.

Returns

The raw json response as a string

Parameters

Name	Type	Description
resellerId	System.String	The id of the reseller
body	System.String	The body of the request

Remarks

body {id: "string" , periodMonths: 1}

ResellerResetPassword(resellerId,body) `method`

Summary

Sends a password reset email, given a password reset token. See passwordResetInfo on the authentication service.

Returns

The raw json response as a string

Parameters

Name	Type	Description
resellerId	System.String	The id of the reseller
body	System.String	The body of the request

ResellerSusers(resellerId) `method`

Summary

Returns your Stack user config.

Returns

The raw json response as a string

Parameters

Name	Type	Description
resellerId	System.String	The id of the reseller

ResellerSusersUpdate(resellerId,body) `method`

Summary

Update your Stack users.

Returns

The raw json response as a string

Parameters

Name	Type	Description
resellerId	System.String	The id of the reseller
body	System.String	The body of the request

Remarks

body: { contact:{ (user_ref):{ person_name: "string", company_name: "string", address: "string", city: "string", sp: "string", pc: "string", cc: "string", voice: "string", notes: "string", billing_ref: "string", email: "string", } }, ftpLock:{ (user_ref):{ existing:{ (lock_ref):{ Ip4Address: "string", Ip6Address: "string", delete: true } }, new:{ Ip4Address: "string", Ip6Address: "string" } } }, grant_map:{ (user_ref):{ (service_ref): true } }, masterFtpAcl:{ (user_ref):{ Ip4Address: ["string"] } }, newUser:{ person_name: "string", company_name: "string", address: "string", city: "string", sp: "string", pc: "string", cc: "string", voice: "string", notes: "string", billing_ref: "string", email: "string", nominet_contact_type: "string", sendNewStackUserEmail: true, }, users:{ (user_ref):{ password: "string", delete: true } }, masterFtp:{ } }

ResellerTransferDomain(resellerId,body) `method`

Summary

Transfer a domain name. This will charge the appropriate transfer fee to your 20i Balance. If you don't have enough left, this will fail. If you enable privacy you will also be charged a fee for the privacy service. This will return true if the transfer purchase was accepted. This doesn't guarantee that the transfer will succeed. Please note you can also just use contract#add, this method only does a simple reformatting to use that. Please see the documentation there for details.

Returns

The raw json response as a string

Parameters

Name	Type	Description
resellerId	System.String	The id of the reseller
body	System.String	The body of the request

Remarks

sample body: { name: "string", years: 1, contact:{ organisation: "string", name: "string", address: "string", telephone: "string", email: "string", cc: "string", pc: "string", sp: "string", city: "string", extension:{ } }, emulateYears: true, otherContacts:{ (type):{ name: "string", organisation: "string", address: "string", city: "string", sp: "string", pc: "string", cc: "string", telephone: "string", email: "string", extension:{ } } }, authcode: "string", limits:{ }, nameservers: ["string"], privacyService: true, stackUser: "string" }

ResellerUpdate(resellerId,body) `method`

Summary

Updates the reseller

Returns

The raw json response as a string

Parameters

Name	Type	Description
resellerId	System.String	The id of the reseller
body	System.String	The body of the request

Remarks

body { malwareEmails: true, malwareEmailsStackCpUsers: true, migrationCompleteEmails: true, domainAutoRenewDefault: true }

ResellerUpdatePackage(resellerId,body) `method`

Summary

Delete web sites or update their limits or labels.

Returns

The raw json response as a string

Parameters

Name	Type	Description
resellerId	System.String	The id of the reseller
body	System.String	The body of the request

Remarks

body { billing:{ (package_id):{ date: "string", interval: 1, preferredUser: "string", } }, delete-id: ["string"], id: ["string"], labels:{ (package_id): "string" }, limit:{ (package_id):{ (limit_code): true } }, limit-set:{ (package_id):{ (limit_code): true } }, packageBundleTypes:{ (package_id): "string" } }

ResellerUpdateWebType(resellerId,body) `method`

Summary

Update web types.

Returns

The raw json response as a string

Parameters

Name	Type	Description
resellerId	System.String	The id of the reseller
body	System.String	The body of the request

Remarks

body { delete-id: ["string"], extraData:{ (id):{ temporaryUrlDomain: "string" } }, id: ["string"], installApps:{ (type_id): ["string"] }, labels:{ }, limit:{ (type_id):{ (limit_code): true } }, platform: "string", syncLimits:{ (type_id): true }, welcomeEmail:{ (id):{ subject: "string", from: "string", content: "string" } } }

SetManagedVpsUserStatus(id,body) `method`

Summary

Activates or deactivates the service. Possible subservice_name are 'default' for a typical set of services and 'main' for the core service only.

Returns

The raw json response as a string

Parameters

Name	Type	Description
id	System.String	The id of the managed vps
body	System.String	The json body to send

Remarks

Json sample body: { includeRepeated: true, subservices:{ (subservice_name): true } }

Product

.NET

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

net6.0
- No dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version	Downloads	Last updated
2022.10.18.155209	866	10/18/2022

20i-api 2022.10.18.155209

20i API dotnet libary

Get started with 3 steps

Methods

TwentyIApi type

Namespace

Summary

#ctor(bearer,client) constructor

Summary

Parameters

GetDomainPeriods() method

Summary

Returns

Parameters

GetDomainPremiumTypes() method

Summary

Returns

Parameters

GetDomainSearch(query) method

Summary

Returns

Parameters

GetDomains() method

Summary

Returns

Parameters

GetManagedVps(id) method

Summary

Returns

Parameters

GetManagedVpsList() method

Summary

Returns

Parameters

GetManagedVpsName(id) method

Summary

Returns

Parameters

GetManagedVpsPackageCount(id) method

Summary

Returns

Parameters

GetMssql() method

Summary

Returns

Parameters

GetMssqlById(id) method

Summary

Returns

Parameters

ManagedVpsAddWeb(id,body) method

Summary

Returns

Parameters

Remarks

ManagedVpsDeleteWeb(id,body) method

Summary

Returns

Parameters

Remarks

ManagedVpsSetName(id,body) method

Summary

Returns

Parameters

Remarks

MssqlLinkPackage(id,body) method

Summary

Returns

Parameters

Remarks

Package() method

Summary

Returns

Parameters

Package(packageId) method

Summary

Returns

Parameters

PackageBundleTypeLimits(packageId) method

Summary

TwentyIApi `type`

#ctor(bearer,client) `constructor`

GetDomainPeriods() `method`

GetDomainPremiumTypes() `method`

GetDomainSearch(query) `method`

GetDomains() `method`

GetManagedVps(id) `method`

GetManagedVpsList() `method`

GetManagedVpsName(id) `method`

GetManagedVpsPackageCount(id) `method`

GetMssql() `method`

GetMssqlById(id) `method`

ManagedVpsAddWeb(id,body) `method`

ManagedVpsDeleteWeb(id,body) `method`

ManagedVpsSetName(id,body) `method`

MssqlLinkPackage(id,body) `method`

Package() `method`

Package(packageId) `method`

PackageBundleTypeLimits(packageId) `method`

PackageDatabaseUser(packageId,databaseId,userId) `method`

PackageDefaultDns(packageId) `method`

PackageDomain(packageId,domainId) `method`

PackageDomainAuthcode(packageId,domainId) `method`

PackageDomainCanTransfer(packageId,domainId) `method`

PackageDomainCanTransfer(packageId,domainId,body) `method`

PackageDomainCancelTransfer(packageId,domainId) `method`

PackageDomainContacts(packageId,domainId) `method`

PackageDomainContacts(packageId,domainId,body) `method`

PackageDomainDns(packageId,domainId) `method`

PackageDomainDnsGoogleApps(packageId,domainId) `method`

PackageDomainDnsGoogleApps(packageId,domainId,body) `method`

PackageDomainDnsGoogleAppsMailOnly(packageId,domainId) `method`

PackageDomainDnsGoogleAppsMailOnly(packageId,domainId,body) `method`

PackageDomainDnsOffice365Mail(packageId,domainId) `method`

PackageDomainDnsOffice365MailOnly(packageId,domainId,body) `method`