Skip to content

Feature/platform apis #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sbarbett merged 3 commits into from
Aug 14, 2025
Merged

Feature/platform apis #10

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
efd177a
feat: added platform-related endpoints
sbarbett Aug 13, 2025
f696ec3
docs: changelog bump
sbarbett Aug 14, 2025
c35cb29
fix: added response examples
sbarbett Aug 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

### Added
- Platform folder for system-related calls
- `/version` request for testing API connectivity
- `/status` request for checking status and auth

## [1.1.0] - 2025-07-17

### Changed
Expand Down
261 changes: 261 additions & 0 deletions src/UDNS.postman_collection.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,267 @@
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
},
"item": [
{
"name": "Platform",
"item": [
{
"name": "Get Version",
"request": {
"auth": {
"type": "noauth"
},
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/version",
"host": [
"{{baseUrl}}"
],
"path": [
"version"
]
},
"description": "The version call provides the version of the REST API currently in production.\n\nThis call does not require an Authorization header to be specified, which allows it to be used to verify that there are no networking issues between a client and the REST API server."
},
"response": [
{
"name": "Get Version",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/version",
"host": [
"{{baseUrl}}"
],
"path": [
"version"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": null,
"header": [
{
"key": "Access-Control-Allow-Headers",
"value": "Origin, X-Requested-With, Content-Type, Accept, Authorization, UltraClient"
},
{
"key": "Access-Control-Allow-Methods",
"value": "POST, GET, OPTIONS, DELETE, PUT, PATCH"
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Access-Control-Max-Age",
"value": "3600"
},
{
"key": "Content-Encoding",
"value": "gzip"
},
{
"key": "Content-Security-Policy",
"value": "default-src 'self' https:; font-src 'self' https: data:; img-src 'self' https: data:; object-src 'none'; script-src https:; style-src 'self' https: 'unsafe-inline'"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Date",
"value": "Wed, 13 Aug 2025 19:17:07 GMT"
},
{
"key": "Referrer-Policy",
"value": "no-referrer"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=31536000; includeSubDomains; preload"
},
{
"key": "Vary",
"value": "Origin"
},
{
"key": "Vary",
"value": "Access-Control-Request-Method"
},
{
"key": "Vary",
"value": "Access-Control-Request-Headers"
},
{
"key": "Vary",
"value": "Accept-Encoding, User-Agent"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-Download-Options",
"value": "noopen"
},
{
"key": "X-Frame-Options",
"value": "DENY"
},
{
"key": "X-Permitted-Cross-Domain-Policies",
"value": "none"
},
{
"key": "X-Xss-Protection",
"value": "1 ; mode=block"
},
{
"key": "transfer-encoding",
"value": "chunked"
},
{
"key": "Connection",
"value": "keep-alive"
}
],
"cookie": [],
"body": "{\n \"version\": \"3.108.0-20250804151109.a1bbd8c\"\n}"
}
]
},
{
"name": "Get Status",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/status",
"host": [
"{{baseUrl}}"
],
"path": [
"status"
]
},
"description": "The status call provides a simple way to determine if the REST API \nis running, and to make sure you are connecting to the UltraDNS Portal \nwith proper authorization."
},
"response": [
{
"name": "Get Status",
"originalRequest": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/status",
"host": [
"{{baseUrl}}"
],
"path": [
"status"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": null,
"header": [
{
"key": "Access-Control-Allow-Headers",
"value": "Origin, X-Requested-With, Content-Type, Accept, Authorization, UltraClient"
},
{
"key": "Access-Control-Allow-Methods",
"value": "POST, GET, OPTIONS, DELETE, PUT, PATCH"
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Access-Control-Max-Age",
"value": "3600"
},
{
"key": "Content-Encoding",
"value": "gzip"
},
{
"key": "Content-Security-Policy",
"value": "default-src 'self' https:; font-src 'self' https: data:; img-src 'self' https: data:; object-src 'none'; script-src https:; style-src 'self' https: 'unsafe-inline'"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Date",
"value": "Wed, 13 Aug 2025 15:00:17 GMT"
},
{
"key": "Referrer-Policy",
"value": "no-referrer"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=31536000; includeSubDomains; preload"
},
{
"key": "Vary",
"value": "Origin"
},
{
"key": "Vary",
"value": "Access-Control-Request-Method"
},
{
"key": "Vary",
"value": "Access-Control-Request-Headers"
},
{
"key": "Vary",
"value": "Accept-Encoding, User-Agent"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-Download-Options",
"value": "noopen"
},
{
"key": "X-Frame-Options",
"value": "DENY"
},
{
"key": "X-Permitted-Cross-Domain-Policies",
"value": "none"
},
{
"key": "X-Xss-Protection",
"value": "1 ; mode=block"
},
{
"key": "transfer-encoding",
"value": "chunked"
},
{
"key": "Connection",
"value": "keep-alive"
}
],
"cookie": [],
"body": "{\n \"message\": \"Good\"\n}"
}
]
}
],
"description": "This folder contains endpoints that provide information about the UltraDNS API platform itself.\n\n- Check API operational status and health\n \n- Retrieve current API version information\n \n- Validate connectivity to the service\n \n\nThese endpoints are intended for integration health checks, monitoring, and ensuring compatibility with the current API version."
},
{
"name": "Zones",
"item": [
Expand Down