Skip to content

Commit

Permalink
Merge pull request #5 from CenturyLinkCloud/master
Browse files Browse the repository at this point in the history
Syncing my fork
  • Loading branch information
jgerger authored Apr 13, 2017
2 parents 7dbccee + fcf509f commit 3eff7e5
Show file tree
Hide file tree
Showing 76 changed files with 4,184 additions and 38 deletions.
18 changes: 10 additions & 8 deletions Data Centers/get-data-center-bare-metal-capabilities.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,9 @@ Use this API operation when you want to discover the available capabilities of r
| id | string | The configurationId to pass to the [Create Server](../Servers/create-server.md) API operation when creating a bare metal server. |
| hourlyRate | number | Price per hour for the given configuration. |
| availability | string | The level of availability for the given configuration: either `high`, `low`, or `none `. |
| memory | complex | Information about the memory on the server. |
| memory | array | Information about the memory on the server. |
| processor | complex | Information about the physical processors on the server. |
| storage | complex | Collection of disk information, each item representing one physical disk on the server. |
| storage | array | Collection of disk information, each item representing one physical disk on the server. |

### Memory Definition
| Name | Type | Description |
Expand All @@ -65,17 +65,19 @@ Use this API operation when you want to discover the available capabilities of r
### Storage Definition
| Name | Type | Description |
| --- | --- | --- |
| type | string | Drive capacity in gigabytes |
| description | string | Friendly description for the OS type |
| hourlyRatePerSocket | number | Price per hour per socket for the OS type. |
| capacityGB | number | Drive capacity in gigabytes |
| speedRpm | number | RPM (revolutions per minutes) speed of the disk |
| type | string | Disk type. Only `Hdd` currently supported. |


### OperatingSystems Definition

| Name | Type | Description |
| --- | --- | --- |
| capacityGB | number | Underlying unique name for the OS type |
| speedRpm | number | RPM (revolutions per minutes) speed of the disk |
| type | string | Disk type. Only `Hdd` currently supported. |
| type | string | Underlying unique name for the OS type |
| description | string | Friendly description for the OS type |
| hourlyRatePerSocket | number | Price per hour per socket for the OS type. |


### Examples

Expand Down
4 changes: 1 addition & 3 deletions Data Centers/get-data-center-deployment-capabilities.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"attachments": []
}}}

Gets the list of capabilities that a specific data center supports for a given account, including the deployable networks, OS templates, and whether features like premium storage and shared load balancer configuration are available. Calls to this operation must include a token acquired from the authentication endpoint. See the [Login API](../Authentication/login.md) for information on acquiring this token.
Gets the list of capabilities that a specific data center supports for a given account, including the deployable networks, OS templates, and whether features like shared load balancer configuration are available. Calls to this operation must include a token acquired from the authentication endpoint. See the [Login API](../Authentication/login.md) for information on acquiring this token.

### When to Use It

Expand Down Expand Up @@ -36,7 +36,6 @@ Use this API operation when you want to discover the available capabilities of a

| Name | Type | Description |
| --- | --- | --- |
| supportsPremiumStorage | boolean | Whether or not this data center provides support for servers with premium storage |
| supportsSharedLoadBalancer | boolean | Whether or not this data center provides support for shared load balancer configuration |
| supportsBareMetalServers | boolean | Whether or not this data center provides support for provisioning bare metal servers |
| deployableNetworks | array | Collection of networks that can be used for deploying servers |
Expand Down Expand Up @@ -68,7 +67,6 @@ Use this API operation when you want to discover the available capabilities of a
#### JSON

{
"supportsPremiumStorage":true,
"supportsBareMetalServers":false,
"supportsSharedLoadBalancer":true,
"deployableNetworks":[
Expand Down
File renamed without changes.
89 changes: 89 additions & 0 deletions Firewall/create-cross-dc-firewall-policy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
{{{
"title": "Create a Cross Data Center Firewall Policy",
"date": "5-23-2016",
"author": "Anthony Hakim",
"attachments": [],
"contentIsHTML": false
}}}

Creates a firewall policy for a given account, between networks in different data centers ("cross data center firewall policy"). Calls to this operation must include a token acquired from the authentication endpoint. See the [Login API](https://www.ctl.io/api-docs/v2/#authentication-login) for information on acquiring this token.

### When to Use It

Use this API operation when you need to create a firewall policy between networks in different data centers for a given account.

NOTE: This API operation is experimental only, and subject to change without notice. Please plan accordingly.

## URL

### Structure

POST https://api.ctl.io/v2-experimental/crossDcFirewallPolicies/{sourceAccountAlias}/{dataCenter}

### Example

POST https://api.ctl.io/v2-experimental/crossDcFirewallPolicies/SRC_ALIAS/VA1

## Request

### URI Parameters

| Name | Type | Description | Req. |
| --- | --- | --- | --- |
| sourceAccountAlias | string | Short code for a particular account | Yes |
| dataCenter | string | Short string representing the target data center for the new policy. Valid codes can be retrieved from the [Get Data Center List](https://www.ctl.io/api-docs/v2/#data-centers-get-data-center) API operation. | Yes |

### Content Properties

| Name | Type | Description | Req. |
| --- | --- | --- | --- |
| destinationAccountId | string | Short code for a particular account | Yes |
| destinationLocationId | string | Short code for a particular location | Yes |
| destinationCidr | string | Destination address for traffic on the terminating firewall, specified using [CIDR notation](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) | Yes |
| enabled | string | Indicates if the policy is enabled (`true`) or disabled (`false`) | Yes |
| sourceCidr | string | Source address for traffic on the originating firewall, specified using [CIDR notation](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing), on the originating firewall | Yes |

### Example

#### JSON
```json
{
"destinationAccountId" : "dest",
"destinationLocationId" : "UC1",
"destinationCidr" : "10.1.1.0/24",
"enabled" : true,
"sourceCidr" : "10.2.2.0/24"
}
```

## Response

The response will be an entity representing the new firewall policy that was created.

### Example

#### JSON
```json
{
"id": "921670344d781378a8df6159c00bddea",
"status": "pending",
"enabled": true,
"sourceCidr": "10.2.2.0/24",
"sourceAccount": "src",
"sourceLocation": "va1",
"destinationCidr": "10.1.1.0/24",
"destinationAccount": "dest",
"destinationLocation": "uc1",
"links": [
{
"rel": "self",
"href": "/v2-experimental/crossDcFirewallPolicies/src/va1/921670344d781378a8df6159c00bddea",
"verbs": [
"GET",
"PUT",
"DELETE"
]
}
]
}
```
File renamed without changes.
39 changes: 39 additions & 0 deletions Firewall/delete-cross-dc-firewall-policy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
{{{
"title": "Delete a Cross Data Center Firewall Policy",
"date": "5-23-2016",
"author": "Anthony Hakim",
"attachments": [],
"contentIsHTML": false
}}}

Deletes a firewall policy for a given account, between networks in different data centers ("cross data center firewall policy"). Calls to this operation must include a token acquired from the authentication endpoint. See the [Login API](https://www.ctl.io/api-docs/v2/#authentication-login) for information on acquiring this token.

### When to Use It

Use this API operation when you need to delete a firewall policy between networks in different data centers.

NOTE: This API operation is experimental only, and subject to change without notice. Please plan accordingly.

## URL

### Structure

DELETE https://api.ctl.io/v2-experimental/crossDcFirewallPolicies/{sourceAccountAlias}/{dataCenter}/{policyId}

### Example

DELETE https://api.ctl.io/v2-experimental/crossDcFirewallPolicies/SRC_ALIAS/VA1/921670344d781378a8df6159c00bddea

## Request

### URI Parameters

| Name | Type | Description | Req. |
| --- | --- | --- | --- |
| sourceAccountAlias | string | Short code for a particular account | Yes |
| dataCenter | string | Short string representing the target data center for the new policy. Valid codes can be retrieved from the [Get Data Center List](https://www.ctl.io/api-docs/v2/#data-centers-get-data-center) API operation. | Yes |
| policyId | string | ID of the firewall policy | Yes |

## Response

There is no response upon the successful removal of the firewall policy.
File renamed without changes.
111 changes: 111 additions & 0 deletions Firewall/get-cross-dc-firewall-policy-list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,111 @@
{{{
"title": "Get Cross Data Center Firewall Policy List",
"date": "5-23-2016",
"author": "Anthony Hakim",
"attachments": [],
"contentIsHTML": false
}}}

Gets the list of firewall policies associated with a given account, between networks in different data centers ("cross data center firewall policies"). Users can optionally filter results by requesting policies associated with a second "destination" account. Calls to this operation must include a token acquired from the authentication endpoint. See the [Login API](https://www.ctl.io/api-docs/v2/#authentication-login) for information on acquiring this token.

### When to Use It

Use this API operation when you need the list of available firewall policies between networks in different data centers.

NOTE: This API operation is experimental only, and subject to change without notice. Please plan accordingly.

## URL

### Structure

GET https://api.ctl.io/v2-experimental/crossDcFirewallPolicies/{sourceAccountId}/{dataCenter}?destinationAccountId={destinationAccountId}

### Example

GET https://api.ctl.io/v2-experimental/crossDcFirewallPolicies/SRC_ALIAS/VA1?destinationAccountId=DEST_ALIAS

## Request

### URI Parameters

| Name | Type | Description | Req. |
| --- | --- | --- | --- |
| sourceAccountId | string | Short code for a particular account | Yes |
| dataCenter | string | Short string representing the target data center for the new policy. Valid codes can be retrieved from the [Get Data Center List](https://www.ctl.io/api-docs/v2/#data-centers-get-data-center) API operation. | Yes |
| destinationAccountId | string | Short code for another account | No |

## Response

### Example

#### JSON
```json
[
{
"id": "921670344d781378a8df6159c00bddea",
"status": "pending",
"enabled": true,
"sourceCidr": "10.2.2.0/24",
"sourceAccount": "src",
"sourceLocation": "va1",
"destinationCidr": "10.1.1.0/24",
"destinationAccount": "dest",
"destinationLocation": "uc1",
"links": [
{
"rel": "self",
"href": "/v2-experimental/crossDcFirewallPolicies/src/va1/921670344d781378a8df6159c00bddea",
"verbs": [
"GET",
"PUT",
"DELETE"
]
}
]
},
{
"id": "1a4b72963130e7a4d1a3343299f84edc",
"status": "active",
"enabled": true,
"sourceCidr": "10.5.5.0/24",
"sourceAccount": "src",
"sourceLocation": "va1",
"destinationCidr": "10.1.1.0/24",
"destinationAccount": "dest1",
"destinationLocation": "uc1",
"links": [
{
"rel": "self",
"href": "/v2-experimental/crossDcFirewallPolicies/src5/wa1/1a4b72963130e7a4d1a3343299f84edc",
"verbs": [
"GET",
"PUT",
"DELETE"
]
}
]
},
{
"id": "372d37109487b0584db2c87b16f654b1",
"status": "active",
"enabled": true,
"sourceCidr": "10.7.7.0/24",
"sourceAccount": "src",
"sourceLocation": "va1",
"destinationCidr": "10.9.9.0/24",
"destinationAccount": "dest2",
"destinationLocation": "il1",
"links": [
{
"rel": "self",
"href": "/v2-experimental/crossDcFirewallPolicies/src7/gb3/372d37109487b0584db2c87b16f654b1",
"verbs": [
"GET",
"PUT",
"DELETE"
]
}
]
}
]
```
65 changes: 65 additions & 0 deletions Firewall/get-cross-dc-firewall-policy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
{{{
"title": "Get Cross Data Center Firewall Policy",
"date": "5-23-2016",
"author": "Anthony Hakim",
"attachments": [],
"contentIsHTML": false
}}}

Gets the details of a specific firewall policy associated with a given account, between networks in different data centers ("cross data center firewall policy"). Calls to this operation must include a token acquired from the authentication endpoint. See the [Login API](https://www.ctl.io/api-docs/v2/#authentication-login) for information on acquiring this token.

### When to Use It

Use this API operation when you need the details of a specific firewall policy between networks in different data centers.

NOTE: This API operation is experimental only, and subject to change without notice. Please plan accordingly.

## URL

### Structure

GET https://api.ctl.io/v2-experimental/crossDcFirewallPolicies/{sourceAccountAlias}/{dataCenter}/{policyId}

### Example

GET https://api.ctl.io/v2-experimental/firewallPolicies/SRC_ALIAS/VA1/921670344d781378a8df6159c00bddea

## Request

### URI Parameters

| Name | Type | Description | Req. |
| --- | --- | --- | --- |
| sourceAccountAlias | string | Short code for a particular account | Yes |
| dataCenter | string | Short string representing the data center you are querying. Valid codes can be retrieved from the [Get Data Center List](https://www.ctl.io/api-docs/v2/#data-centers-get-data-center) API operation. | Yes |
| policyId | string | ID of the firewall policy | Yes |

## Response

### Example

#### JSON
```json
{
"id": "921670344d781378a8df6159c00bddea",
"status": "active",
"enabled": true,
"sourceCidr": "10.2.2.0/24",
"sourceAccount": "src",
"sourceLocation": "va1",
"destinationCidr": "10.1.1.0/24",
"destinationAccount": "dest",
"destinationLocation": "uc1",
"links": [
{
"rel": "self",
"href": "/v2-experimental/crossDcFirewallPolicies/src/va1/921670344d781378a8df6159c00bddea",
"verbs": [
"GET",
"PUT",
"DELETE"
]
}
]
}
```
File renamed without changes.
File renamed without changes.
File renamed without changes.
Loading

0 comments on commit 3eff7e5

Please sign in to comment.