Important variable names¶
Specific names are used in the descriptions of the endpoints for the API to better distinguish the individual variables in the request path.
Below you will find a list of all names used, the assigned object and attributes, as well as information on how to obtain the corresponding value for the variable.
| Name | Object | Name in path | GET request to obtain the information |
|---|---|---|---|
| Group-ID | GroupVO | id; groupId |
/user/groups |
| User-ID | UserVO | id; userId |
/users |
| Permission-ID | ObjectPermissionVO | id |
/user/group/{Group-ID}/permission<br>/user/{User-ID}/permission |
| Domain-ID | DomainsVO | domainId |
/domains |
| DNS-Record-ID | DnsRecordVO | id |
/domains<br>/domains/<Domain-ID> |
| Subdomain-ID | DnsRecordVO | vhostId |
/domain/<Domain-ID><br>/dns-records |
| IP-Target | DomainBindVO | ipTarget |
|
| IP-Filter-ID | IpFilterVO | id |
/domain/<Domain-ID>/ip-filters/<Subdomain name> |
| Subdomainname | DnsRecordVO | vHostName; subDomainName; name |
/domain/<Domain-ID><br>/dns-records |
| Redirect-ID | DnsRedirectVO | id | /domain/<Domain-ID>/redirects/<Subdomain name> |
| Cache-Settings-ID | CacheSettingVO | id | /domain/ |
| Tag-ID | TagVO | tagId |
/tags |
| Waiting-Room-ID | WaitingRoomVO | id |
/waiting-room |
| WAF-ID | WafRuleVO | id |
/domain/<Domain-ID>/waf-rules<br>/tag/<Tag-ID>/waf-rules |
| SSL-ID | SslCertVO | id |
/domain/<Domain-ID>/ssl/certificates |
| Maintenance-Page-ID | MaintenanceVO | id |
/domain/<Domain-ID>/<Subdomain name>/maintenance |
| Tag-Information-ID | TagInformationVO | id |
/tags/<T/tags//information/information |
| SSL-ID | SslCertVO | id |
/domain/<Domain-ID>/ssl/certificates |
| Contact-ID | OrganizationContactVO | id |
/organization/contacts |
| API-KEY-ID | ApiKeyVO | id |
/user/{userId}/api-keys/{id} |
| Session-ID | UserSessionVO | id |
/user/{userId} |
| Report-ID | id |
/reports-v2 |
|
| Subscription-ID | id |
/report-subscriptions |