REST Methods
VERB | RESOURCE | PARAMETERS (TYPE) | DESCRIPTION |
GET | /assets/community |
|
Retrieve a list of community assets. |
GET | /assets/community/{asset_type} |
|
Retrieve a list of community assets by type. |
GET | /assets/community/{asset_type}/{asset_id} |
|
Retrieve detailed asset information. |
GET | /assets/private |
|
Retrieve a list of private assets. |
GET | /assets/private/{asset_type} |
|
Retrieve a list of private assets. |
GET | /assets/private/{asset_type}/{asset_id} |
|
Retrieve details about an asset. |
POST | /assets/private |
|
Creates new private assets. |
POST | /assets/private/{asset_type} |
|
Creates new private assets. |
PUT | /assets/private/{asset_type}/{asset_id} |
|
Update an existing private asset. |
DELETE | /assets/private/{asset_type}/{asset_id} |
|
Delete a private asset. |
GET /assets/community
Retrieve a list of community assets
SAMPLE URI: GET https://portfolio.dynapis.com/assets/community
Parameters
- None
Example Request/Response (JSON)
{ "_self": "https://portfolio.dynapis.com/assets/community", "_items": [ { "_self": "https://portfolio.dynapis.com/assets/community/cdns/1", "id": "1", "name": "Akamai", "type": "cdn", "value": "Akamai" }, { "_self": "https://portfolio.dynapis.com/assets/community/endpoints/9999", "id": "9999", "name": "Endpoint - Unhealthy", "type": "endpoint", "value": "Endpoint - Unhealthy" } ] }
GET /assets/community/{asset_type}
Retrieve a list of community assets by type.
SAMPLE URI: GET https://portfolio.dynapis.com/assets/community/{asset_type}
Parameters
Asset_Type
– (Path) The type of the asset. Valid values: cdns or endpoints.
NOTE: The Asset_Type valid values are plural (cdns or endpoints) when used in the URL path. The “type” parameter is singular (cdn or endpoint) when it appears in the request/response body.
Example Request/Response (JSON)
{ "_self": "https://portfolio.dynapis.com/assets/community/cdns", "_items": [ { "_self": "https://portfolio.dynapis.com/assets/community/cdns/1", "id": "1", "name": "Akamai", "type": "cdn", "value": "Akamai" }, { "_self": "https://portfolio.dynapis.com/assets/community/cdns/2", "id": "2", "name": "Limelight", "type": "cdn", "value": "Limelight" } ] }
GET /assets/community/{asset_type}/{asset_id}
Retrieve detailed asset information.
SAMPLE URI: GET https://portfolio.dynapis.com/assets/community/{asset_type}/{asset_id}
Parameters
asset_type
– The type of the asset. Valid values: cdns or endpoints.
NOTE: The Asset_Type valid values are plural (cdns or endpoints) when used in the URL path. The “type” parameter is singular (cdn or endpoint) when it appears in the request/response body.asset_id
– Unique identifier for an asset. Must be unique within an asset type.
Example Request/Response (JSON)
{ "_self": "https://portfolio.dynapis.com/assets/community/cdns/3", "id": "3", "name": "Level3", "type": "cdn", "value": "Level3" }
GET /assets/private
Retrieve a list of private assets.
SAMPLE URI: GET https://portfolio.dynapis.com/assets/private
Parameters
None.
Example Request/Response (JSON)
{ "_self": "https://portfolio.dynapis.com/assets/private", "_items": [ { "_self": "https://portfolio.dynapis.com/assets/private/cdns/6001", "id": "6001", "name": "LICDN-6001-ECH2", "type": "cdn", "value": "LICDN-6001-ECH2", "customer_id": 43529 }, { "_self": "https://portfolio.dynapis.com/assets/private/endpoints/9998", "id": "9998", "name": "Endpoint - Healthy", "type": "endpoint", "value": "Endpoint - Healthy", "customer_id": 43529 }, { "_self": "https://portfolio.dynapis.com/assets/private/endpoints/9999", "id": "9999", "name": "Endpoint - Unhealthy", "type": "endpoint", "value": "Endpoint - Unhealthy", "customer_id": 43529 } ] }
GET /assets/private/{asset_type}
Retrieve a list of private assets of a particular type.
SAMPLE URI: GET https://portfolio.dynapis.com/assets/private/{asset_type}
Parameters
asset_type
– (path) The type of the asset. Valid values: cdns or endpoints.
NOTE: The Asset_Type valid values are plural (cdns or endpoints) when used in the URL path. The “type” parameter is singular (cdn or endpoint) when it appears in the request/response body.
Example Request/Response (JSON)
"_self": "https://portfolio.dynapis.com/assets/private/endpoints", "_items": [ { "_self": "https://portfolio.dynapis.com/assets/private/endpoints/9998", "id": "9998", "name": "Endpoint - Healthy", "type": "endpoint", "value": "Endpoint - Healthy", "customer_id": 43529 }, { "_self": "https://portfolio.dynapis.com/assets/private/endpoints/9999", "id": "9999", "name": "Endpoint - Unhealthy", "type": "endpoint", "value": "Endpoint - Unhealthy", "customer_id": 43529 } ] }
GET /assets/private/{asset_type}/{asset_id}
Retrieve detailed asset information.
SAMPLE URI: GET https://portfolio.dynapis.com/assets/private/{asset_type} /{asset_id}
Parameters
asset_type
– (path) The type of the asset. Valid values: cdns or endpoints.
NOTE: The Asset_Type valid values are plural (cdns or endpoints) when used in the URL path. The “type” parameter is singular (cdn or endpoint) when it appears in the request/response body.asset_id
– (path) Unique identifier for an asset. Must be unique within an asset type.
Example Request/Response (JSON)
{ "_self": "https://portfolio.dynapis.com/assets/private/endpoints/9999", "id": "9999", "name": "Endpoint - Unhealthy", "type": "endpoint", "value": "Endpoint - Unhealthy", "customer_id": 43529 }
POST /assets/private
Create new private assets.
SAMPLE URI: POST https://portfolio.dynapis.com/assets/private
Parameters
assets
– (body) New list of community assets to create.
Asset Properties- id – Asset ID.
- type – Type of Asset.
- name – Name of Asset.
- transport –IPv4, IPv6, or null.
- value – The value of the asset, for example, an IP address, cloud name, URL, etc.
Example Request/Response (JSON)
"_self": "https://portfolio.dynapis.com/assets/private", "_items": [ { "_self": "https://portfolio.dynapis.com/assets/private/cdns/7777", "id": "7777", "name": "LICDN-7777-IDB2", "type": "cdn", "value": "LICDN-7777-IDB2", "customer_id": 43529 }, { "_self": "https://portfolio.dynapis.com/assets/private/endpoints/9999", "id": "9999", "name": "Endpoint - Unhealthy", "type": "endpoint", "value": "Endpoint - Unhealthy", "customer_id": 43529 } ] }
POST /assets/private/{asset_type}
Create new private assets.
SAMPLE URI: GET https://portfolio.dynapis.com/assets/private/{asset_type}
Parameters
asset_type
– (path) The type of the asset. Valid values: cdns or endpoints.
NOTE: The Asset_Type valid values are plural (cdns or endpoints) when used in the URL path. The “type” parameter is singular (cdn or endpoint) when it appears in the request/response body.assets
– (body) New list of community assets to create.
Asset Properties- id – Asset ID.
- type – Type of Asset.
- name – Name of Asset.
- transport –IPv4, IPv6, or null.
- value – The value of the asset, for example, an IP address, cloud name, URL, etc.
Example Request/Response (JSON)
"_self": "https://portfolio.dynapis.com/assets/private", "_items": [ { "_self": "https://portfolio.dynapis.com/assets/private/cdns/7777", "id": "7777", "name": "LICDN-7777-IDB2", "type": "cdn", "value": "LICDN-7777-IDB2", "customer_id": 43529 }, { "_self": "https://portfolio.dynapis.com/assets/private/endpoints/9999", "id": "9999", "name": "Endpoint - Unhealthy", "type": "endpoint", "value": "Endpoint - Unhealthy", "customer_id": 43529 } ] }
PUT /assets/private/{asset_type}/{asset_id}
Update an existing private asset.
SAMPLE URI: PUT https://portfolio.dynapis.com/assets/private/{asset_type}/{asset_id}
Parameters
asset_type
– (path) The type of the asset. Valid values: cdns or endpoints.
NOTE: The Asset_Type valid values are plural (cdns or endpoints) when used in the URL path. The “type” parameter is singular (cdn or endpoint) when it appears in the request/response body.asset_id
– (path) Unique identifier for an asset. Must be unique within an asset type.assets
– (body) New list of private assets to create.
Asset Properties- id – Asset ID.
- type – Type of Asset.
- name – Name of Asset.
- transport – IPv4, IPv6, or null.
- value – The value of the asset, for example, an IP address, cloud name, URL, etc.
Example Request/Response (JSON)
{ "_self": "https://portfolio.dynapis.com/assets/private/cdns/443101", "id": "443101", "name": "LICDN-443101", "type": "cdn", "value": "LICDN-443101", "customer_id": 43529 }
DELETE /assets/private/{asset_type}/{asset_id}
Delete a private asset.
SAMPLE URI: DELETE https://portfolio.dynapis.com/assets/private/{asset_type}/{asset_id}
Parameters
asset_type
– (path) The type of the asset. Valid values: cdns or endpoints.
NOTE: The Asset_Type valid values are plural (cdns or endpoints) when used in the URL path. The “type” parameter is singular (cdn or endpoint) when it appears in the request/response body.asset_id
– (path) Unique identifier for an asset. Must be unique within an asset type.