Wichtige Variablennamen¶
In den Beschreibungen der Endpunkte für die API werden für eine bessere Abgrenzung der einzelnen Variablen im Pfad der Anfrage spezifische Namen verwendet.
Im Folgenden finden Sie eine Liste aller verwendeten Namen, dem zugeordneten Objekt und Attribute sowie Informationen, wie Sie an den entsprechenden Wert für die Variable gelangen können
| Name | Objekt | Name im Pfad | GET-Anfrage zum Erhalt der 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/<Domain-ID>/<Subdomain name>/cache-settings |
| 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/<Tag-ID>/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 |