API Environments v0.16.2

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

An API to manage runtime API environments. API environments are targets where a developer requests API keys to allow their app to call Apiture APIs. These may be test or UAT environments, partner environments, demo environments, or full production environments.

Error Types

Error responses in this API may have one of the type values described below. See Errors for more information on error responses and error types.

environmentRefNotFound

Description: An environment referenced in an operation does not exist.
Remediation: Use a reference to an existing API environment.

The attributes object in the error may have the following properties:

environmentTypeNotAllowed

Description: The given environment type is not allowed for this DevPortal instance.
Remediation: Only register environment types as listed in the response from the getAllowedEnvironmentTypes operation.

hostAlreadyExists

Description: An environment with the specified host already exists.
Remediation: Use a unique host.

The attributes object in the error may have the following properties:

mismatchedHostType

Description: The host has a deployment type that is not consistent with the chosen environment type.
Remediation: Use the correct host type that corresponds to the underlying Apiture Open host deployment type (stage) as per Platform Engineering's Environments API.

Download OpenAPI Definition (YAML)

Base URLs:

• https://api.devbank.apiture.com/apiEnvironments

Terms of service

Email: Apiture Web: Apiture

Authentication

• API Key (apiKey)
  • header parameter: API-Key
  • API Key based authentication. Each client application must pass its private, unique API key, allocated in the developer portal, via the API-Key: {api-key} request header.

• OAuth2 authentication (accessToken)
  • OAuth2 client access token authentication. The client authenticates against the server at authorizationUrl, passing the client's private clientId (and optional clientSecret) as part of this flow. The client obtains an access token from the server at tokenUrl. It then passes the received access token via the Authorization: Bearer {access-token} header in subsequent API calls. The authorization process also returns a refresh token which the client should use to renew the access token before it expires.
  • Flow: authorizationCode
  • Authorization URL = https://api.developer.apiture.com/auth/oauth2/authorize
  • Token URL = https://api.developer.apiture.com/auth/oauth2/token

API

Endpoints which describe this API.

getApi

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/apiEnvironments/ \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY'

GET https://api.devbank.apiture.com/apiEnvironments/ HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'API-Key':'API_KEY'

};

fetch('https://api.devbank.apiture.com/apiEnvironments/',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

var headers = {
  'Accept':'application/hal+json',
  'API-Key':'API_KEY'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/apiEnvironments/',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'API-Key' => 'API_KEY'
}

result = RestClient.get 'https://api.devbank.apiture.com/apiEnvironments/',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'API-Key': 'API_KEY'
}

r = requests.get('https://api.devbank.apiture.com/apiEnvironments/', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/apiEnvironments/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        "API-Key": []string{"API_KEY"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.devbank.apiture.com/apiEnvironments/", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Top-level resources and operations in this API

GET https://api.devbank.apiture.com/apiEnvironments/

Return links to the top-level resources and operations in this API.

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/common/root/v2.1.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "id": "apiName",
  "name": "API name",
  "apiVersion": "1.0.0"
}

Responses

getApiDoc

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/apiEnvironments/apiDoc \
  -H 'Accept: application/json' \
  -H 'API-Key: API_KEY'

GET https://api.devbank.apiture.com/apiEnvironments/apiDoc HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/json

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'API-Key':'API_KEY'

};

fetch('https://api.devbank.apiture.com/apiEnvironments/apiDoc',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

var headers = {
  'Accept':'application/json',
  'API-Key':'API_KEY'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/apiEnvironments/apiDoc',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'API-Key' => 'API_KEY'
}

result = RestClient.get 'https://api.devbank.apiture.com/apiEnvironments/apiDoc',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'API-Key': 'API_KEY'
}

r = requests.get('https://api.devbank.apiture.com/apiEnvironments/apiDoc', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/apiEnvironments/apiDoc");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "API-Key": []string{"API_KEY"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.devbank.apiture.com/apiEnvironments/apiDoc", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Return API definition document

GET https://api.devbank.apiture.com/apiEnvironments/apiDoc

Return the OpenAPI document that describes this API. An environment must be inactive before it may be deleted.

Example responses

200 Response

{}

Responses

Response Schema

Environments

API Runtime Environments

getEnvironments

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/apiEnvironments/environments \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY'

GET https://api.devbank.apiture.com/apiEnvironments/environments HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'API-Key':'API_KEY'

};

fetch('https://api.devbank.apiture.com/apiEnvironments/environments',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

var headers = {
  'Accept':'application/hal+json',
  'API-Key':'API_KEY'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/apiEnvironments/environments',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'API-Key' => 'API_KEY'
}

result = RestClient.get 'https://api.devbank.apiture.com/apiEnvironments/environments',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'API-Key': 'API_KEY'
}

r = requests.get('https://api.devbank.apiture.com/apiEnvironments/environments', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/apiEnvironments/environments");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        "API-Key": []string{"API_KEY"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.devbank.apiture.com/apiEnvironments/environments", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Return a collection of environments

GET https://api.devbank.apiture.com/apiEnvironments/environments

Return a paginated filterable collection of environments. The links in the response include pagination links.

Parameters

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/apiEnvironments/environments/v1.0.1/profile.json",
  "_links": {
    "self": {
      "href": "/apiEnvironments/environments?start=g434ljkf430&limit=10"
    },
    "next": {
      "href": "/apiEnvironments/environments?start=p4900sk3df9&limit=10"
    },
    "collection": {
      "href": "/apiEnvironments/environments"
    }
  },
  "start": "g434ljkf430",
  "limit": 10,
  "name": "environments",
  "_embedded": {
    "items": [
      {
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "name": "DevBank",
        "host": "api.devbank.apiture.com",
        "domains": [],
        "state": "active",
        "type": "development",
        "_profile": "https://production.api.apiture.com/schemas/apiEnvironments/environment/v1.0.1/profile.json",
        "_links": {
          "self": {
            "href": "/apiEnvironments/environments/0399abed-fd3d-4830-a88b-30f38b8a365c"
          },
          "apiture:webApplication": {
            "href": "https://devbank.apiture.com/"
          }
        }
      },
      {
        "_id": "d62c0701-0d74-4836-83f9-ebf3709442ea",
        "_profile": "https://production.api.apiture.com/schemas/apiEnvironments/environment/v1.0.1/profile.json",
        "name": "Team5",
        "host": "api.open-sandbox-team5.apiture.com",
        "domains": [
          "apiture.com",
          "apitureqa.com"
        ],
        "state": "active",
        "type": "development",
        "_links": {
          "self": {
            "href": "/apiEnvironments/environments/d62c0701-0d74-4836-83f9-ebf3709442ea"
          },
          "apiture:webApplication": {
            "href": "https://open-sandbox-team5.apiture.com"
          }
        }
      }
    ]
  }
}

Responses

createEnvironment

Code samples

# You can also use wget
curl -X POST https://api.devbank.apiture.com/apiEnvironments/environments \
  -H 'Content-Type: application/hal+json' \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.devbank.apiture.com/apiEnvironments/environments HTTP/1.1
Host: api.devbank.apiture.com
Content-Type: application/hal+json
Accept: application/hal+json

const fetch = require('node-fetch');
const inputBody = '{
  "_profile": "https://production.api.apiture.com/schemas/apiEnvironments/environment/v1.0.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "name": "DevBank",
  "description": "The sample runtime environment attached to the developer portal.",
  "host": "api.devbank.apiture.com",
  "authenticationParameters": {
    "identityGroupId": "63438dc44d3e949befcb7f6c2411"
  },
  "domains": [
    "apiture.com"
  ],
  "state": "active"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/apiEnvironments/environments',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

var headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/apiEnvironments/environments',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/hal+json',
  'Accept' => 'application/hal+json',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.devbank.apiture.com/apiEnvironments/environments',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/hal+json',
  'Accept': 'application/hal+json',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.devbank.apiture.com/apiEnvironments/environments', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/apiEnvironments/environments");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/hal+json"},
        "Accept": []string{"application/hal+json"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.devbank.apiture.com/apiEnvironments/environments", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Create a new environment

POST https://api.devbank.apiture.com/apiEnvironments/environments

Create a new environment in the environments collection. The host must be unique.

Body parameter

{
  "_profile": "https://production.api.apiture.com/schemas/apiEnvironments/environment/v1.0.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "name": "DevBank",
  "description": "The sample runtime environment attached to the developer portal.",
  "host": "api.devbank.apiture.com",
  "authenticationParameters": {
    "identityGroupId": "63438dc44d3e949befcb7f6c2411"
  },
  "domains": [
    "apiture.com"
  ],
  "state": "active"
}

Parameters

Example responses

201 Response

{
  "_profile": "https://production.api.apiture.com/schemas/apiEnvironments/environment/v1.0.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "name": "DevBank",
  "description": "The sample runtime environment attached to the developer portal.",
  "host": "api.devbank.apiture.com",
  "authenticationParameters": {
    "identityGroupId": "63438dc44d3e949befcb7f6c2411"
  },
  "domains": [
    "apiture.com"
  ],
  "state": "active"
}

Responses

getEnvironment

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/apiEnvironments/environments/{environmentId} \
  -H 'Accept: application/hal+json' \
  -H 'If-None-Match: string' \
  -H 'API-Key: API_KEY'

GET https://api.devbank.apiture.com/apiEnvironments/environments/{environmentId} HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-None-Match: string

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'If-None-Match':'string',
  'API-Key':'API_KEY'

};

fetch('https://api.devbank.apiture.com/apiEnvironments/environments/{environmentId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

var headers = {
  'Accept':'application/hal+json',
  'If-None-Match':'string',
  'API-Key':'API_KEY'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/apiEnvironments/environments/{environmentId}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'If-None-Match' => 'string',
  'API-Key' => 'API_KEY'
}

result = RestClient.get 'https://api.devbank.apiture.com/apiEnvironments/environments/{environmentId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'If-None-Match': 'string',
  'API-Key': 'API_KEY'
}

r = requests.get('https://api.devbank.apiture.com/apiEnvironments/environments/{environmentId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/apiEnvironments/environments/{environmentId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        "If-None-Match": []string{"string"},
        "API-Key": []string{"API_KEY"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.devbank.apiture.com/apiEnvironments/environments/{environmentId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Fetch a representation of this environment

GET https://api.devbank.apiture.com/apiEnvironments/environments/{environmentId}

Return a HAL representation of this environment resource.

Parameters

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/apiEnvironments/environment/v1.0.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "name": "DevBank",
  "description": "The sample runtime environment attached to the developer portal.",
  "host": "api.devbank.apiture.com",
  "authenticationParameters": {
    "identityGroupId": "63438dc44d3e949befcb7f6c2411"
  },
  "domains": [
    "apiture.com"
  ],
  "state": "active"
}

Responses

updateEnvironment

Code samples

# You can also use wget
curl -X PUT https://api.devbank.apiture.com/apiEnvironments/environments/{environmentId} \
  -H 'Content-Type: application/hal+json' \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

PUT https://api.devbank.apiture.com/apiEnvironments/environments/{environmentId} HTTP/1.1
Host: api.devbank.apiture.com
Content-Type: application/hal+json
Accept: application/hal+json
If-Match: string

const fetch = require('node-fetch');
const inputBody = '{
  "_profile": "https://production.api.apiture.com/schemas/apiEnvironments/environment/v1.0.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "name": "DevBank",
  "description": "The sample runtime environment attached to the developer portal.",
  "host": "api.devbank.apiture.com",
  "authenticationParameters": {
    "identityGroupId": "63438dc44d3e949befcb7f6c2411"
  },
  "domains": [
    "apiture.com"
  ],
  "state": "active"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/apiEnvironments/environments/{environmentId}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

var headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/apiEnvironments/environments/{environmentId}',
  method: 'put',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/hal+json',
  'Accept' => 'application/hal+json',
  'If-Match' => 'string',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.put 'https://api.devbank.apiture.com/apiEnvironments/environments/{environmentId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/hal+json',
  'Accept': 'application/hal+json',
  'If-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('https://api.devbank.apiture.com/apiEnvironments/environments/{environmentId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/apiEnvironments/environments/{environmentId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/hal+json"},
        "Accept": []string{"application/hal+json"},
        "If-Match": []string{"string"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.devbank.apiture.com/apiEnvironments/environments/{environmentId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Update this environment

PUT https://api.devbank.apiture.com/apiEnvironments/environments/{environmentId}

Perform a complete replacement of this environment.

Body parameter

{
  "_profile": "https://production.api.apiture.com/schemas/apiEnvironments/environment/v1.0.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "name": "DevBank",
  "description": "The sample runtime environment attached to the developer portal.",
  "host": "api.devbank.apiture.com",
  "authenticationParameters": {
    "identityGroupId": "63438dc44d3e949befcb7f6c2411"
  },
  "domains": [
    "apiture.com"
  ],
  "state": "active"
}

Parameters

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/apiEnvironments/environment/v1.0.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "name": "DevBank",
  "description": "The sample runtime environment attached to the developer portal.",
  "host": "api.devbank.apiture.com",
  "authenticationParameters": {
    "identityGroupId": "63438dc44d3e949befcb7f6c2411"
  },
  "domains": [
    "apiture.com"
  ],
  "state": "active"
}

Responses

patchEnvironment

Code samples

# You can also use wget
curl -X PATCH https://api.devbank.apiture.com/apiEnvironments/environments/{environmentId} \
  -H 'Content-Type: application/hal+json' \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

PATCH https://api.devbank.apiture.com/apiEnvironments/environments/{environmentId} HTTP/1.1
Host: api.devbank.apiture.com
Content-Type: application/hal+json
Accept: application/hal+json
If-Match: string

const fetch = require('node-fetch');
const inputBody = '{
  "_profile": "https://production.api.apiture.com/schemas/apiEnvironments/environment/v1.0.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "name": "DevBank",
  "description": "The sample runtime environment attached to the developer portal.",
  "host": "api.devbank.apiture.com",
  "authenticationParameters": {
    "identityGroupId": "63438dc44d3e949befcb7f6c2411"
  },
  "domains": [
    "apiture.com"
  ],
  "state": "active"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/apiEnvironments/environments/{environmentId}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

var headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/apiEnvironments/environments/{environmentId}',
  method: 'patch',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/hal+json',
  'Accept' => 'application/hal+json',
  'If-Match' => 'string',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.patch 'https://api.devbank.apiture.com/apiEnvironments/environments/{environmentId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/hal+json',
  'Accept': 'application/hal+json',
  'If-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('https://api.devbank.apiture.com/apiEnvironments/environments/{environmentId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/apiEnvironments/environments/{environmentId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/hal+json"},
        "Accept": []string{"application/hal+json"},
        "If-Match": []string{"string"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "https://api.devbank.apiture.com/apiEnvironments/environments/{environmentId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Update this environment

PATCH https://api.devbank.apiture.com/apiEnvironments/environments/{environmentId}

Perform a partial update of this environment. Fields which are omitted are not updated. Nested _embedded and _links are ignored if included.

Body parameter

{
  "_profile": "https://production.api.apiture.com/schemas/apiEnvironments/environment/v1.0.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "name": "DevBank",
  "description": "The sample runtime environment attached to the developer portal.",
  "host": "api.devbank.apiture.com",
  "authenticationParameters": {
    "identityGroupId": "63438dc44d3e949befcb7f6c2411"
  },
  "domains": [
    "apiture.com"
  ],
  "state": "active"
}

Parameters

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/apiEnvironments/environment/v1.0.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "name": "DevBank",
  "description": "The sample runtime environment attached to the developer portal.",
  "host": "api.devbank.apiture.com",
  "authenticationParameters": {
    "identityGroupId": "63438dc44d3e949befcb7f6c2411"
  },
  "domains": [
    "apiture.com"
  ],
  "state": "active"
}

Responses

deleteEnvironment

Code samples

# You can also use wget
curl -X DELETE https://api.devbank.apiture.com/apiEnvironments/environments/{environmentId} \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

DELETE https://api.devbank.apiture.com/apiEnvironments/environments/{environmentId} HTTP/1.1
Host: api.devbank.apiture.com

const fetch = require('node-fetch');

const headers = {
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/apiEnvironments/environments/{environmentId}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

var headers = {
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/apiEnvironments/environments/{environmentId}',
  method: 'delete',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

headers = {
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete 'https://api.devbank.apiture.com/apiEnvironments/environments/{environmentId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('https://api.devbank.apiture.com/apiEnvironments/environments/{environmentId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/apiEnvironments/environments/{environmentId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://api.devbank.apiture.com/apiEnvironments/environments/{environmentId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Delete this environment resource

DELETE https://api.devbank.apiture.com/apiEnvironments/environments/{environmentId}

Delete this environment resource and any resources that are owned by it. An environment must be inactive before it may be deleted.

Parameters

Responses

getAllowedEnvironmentTypes

Code samples

# You can also use wget
curl -X GET https://api.devbank.apiture.com/apiEnvironments/allowedEnvironmentTypes \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY'

GET https://api.devbank.apiture.com/apiEnvironments/allowedEnvironmentTypes HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'API-Key':'API_KEY'

};

fetch('https://api.devbank.apiture.com/apiEnvironments/allowedEnvironmentTypes',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

var headers = {
  'Accept':'application/hal+json',
  'API-Key':'API_KEY'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/apiEnvironments/allowedEnvironmentTypes',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'API-Key' => 'API_KEY'
}

result = RestClient.get 'https://api.devbank.apiture.com/apiEnvironments/allowedEnvironmentTypes',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'API-Key': 'API_KEY'
}

r = requests.get('https://api.devbank.apiture.com/apiEnvironments/allowedEnvironmentTypes', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/apiEnvironments/allowedEnvironmentTypes");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        "API-Key": []string{"API_KEY"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.devbank.apiture.com/apiEnvironments/allowedEnvironmentTypes", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Return the environment types allowed for this DevPortal instance

GET https://api.devbank.apiture.com/apiEnvironments/allowedEnvironmentTypes

Return the environment types allowed for this DevPortal instance. For example, sandbox or integration DevPortal instances may not manipulate production or partner API environments.

Example responses

OK.

{
  "_profile": "https://production.api.apiture.com/schemas/apiEnvironments/allowedEnvironmentTypes/v1.0.1/profile.json",
  "types": [
    "development",
    "demo",
    "qualityAssurance",
    "uat"
  ]
}

{
  "_profile": "https://production.api.apiture.com/schemas/apiEnvironments/allowedEnvironmentTypes/v1.0.1/profile.json",
  "types": [
    "partner",
    "uat",
    "production"
  ]
}

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/apiEnvironments/allowedEnvironmentTypes/v1.0.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "types": [
    "development",
    "demo",
    "qualityAssurance",
    "uat"
  ]
}

Responses

updateAllowedEnvironmentTypes

Code samples

# You can also use wget
curl -X PUT https://api.devbank.apiture.com/apiEnvironments/allowedEnvironmentTypes \
  -H 'Content-Type: application/hal+json' \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

PUT https://api.devbank.apiture.com/apiEnvironments/allowedEnvironmentTypes HTTP/1.1
Host: api.devbank.apiture.com
Content-Type: application/hal+json
Accept: application/hal+json

const fetch = require('node-fetch');
const inputBody = '{
  "_profile": "https://production.api.apiture.com/schemas/apiEnvironments/allowedEnvironmentTypes/v1.0.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "types": [
    "development",
    "demo",
    "qualityAssurance",
    "uat"
  ]
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/apiEnvironments/allowedEnvironmentTypes',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

var headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/apiEnvironments/allowedEnvironmentTypes',
  method: 'put',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/hal+json',
  'Accept' => 'application/hal+json',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.put 'https://api.devbank.apiture.com/apiEnvironments/allowedEnvironmentTypes',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/hal+json',
  'Accept': 'application/hal+json',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('https://api.devbank.apiture.com/apiEnvironments/allowedEnvironmentTypes', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/apiEnvironments/allowedEnvironmentTypes");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/hal+json"},
        "Accept": []string{"application/hal+json"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://api.devbank.apiture.com/apiEnvironments/allowedEnvironmentTypes", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Update the environment types allowed for this DevPortal instance

PUT https://api.devbank.apiture.com/apiEnvironments/allowedEnvironmentTypes

Update the environment types allowed for this DevPortal instance.

Body parameter

{
  "_profile": "https://production.api.apiture.com/schemas/apiEnvironments/allowedEnvironmentTypes/v1.0.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "types": [
    "development",
    "demo",
    "qualityAssurance",
    "uat"
  ]
}

Parameters

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/apiEnvironments/allowedEnvironmentTypes/v1.0.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "types": [
    "development",
    "demo",
    "qualityAssurance",
    "uat"
  ]
}

Responses

Environment States

API Runtime Environments states

deactivateEnvironment

Code samples

# You can also use wget
curl -X POST https://api.devbank.apiture.com/apiEnvironments/inactiveEnvironments?environment=string \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.devbank.apiture.com/apiEnvironments/inactiveEnvironments?environment=string HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-Match: string

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/apiEnvironments/inactiveEnvironments?environment=string',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

var headers = {
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/apiEnvironments/inactiveEnvironments',
  method: 'post',
  data: '?environment=string',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'If-Match' => 'string',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.devbank.apiture.com/apiEnvironments/inactiveEnvironments',
  params: {
  'environment' => 'string'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'If-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.devbank.apiture.com/apiEnvironments/inactiveEnvironments', params={
  'environment': 'string'
}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/apiEnvironments/inactiveEnvironments?environment=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        "If-Match": []string{"string"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.devbank.apiture.com/apiEnvironments/inactiveEnvironments", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Deactivate an environment

POST https://api.devbank.apiture.com/apiEnvironments/inactiveEnvironments

Update an environment by adding it to the set of inactive environments. This changes the state property of the environment to inactive. This operation is available via the apiture:deactivate link on the environment resource, if and only if the environment is eligible for the deactivate operation. An environment may not be deactivated if it is in use by any client applications, unless the ?force=true option is used.

The responses is the updated representation of the environment. The If-Match request header value, if used, must match the current entity tag value of the environment.

Parameters

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/apiEnvironments/environment/v1.0.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "name": "DevBank",
  "description": "The sample runtime environment attached to the developer portal.",
  "host": "api.devbank.apiture.com",
  "authenticationParameters": {
    "identityGroupId": "63438dc44d3e949befcb7f6c2411"
  },
  "domains": [
    "apiture.com"
  ],
  "state": "active"
}

Responses

activateEnvironment

Code samples

# You can also use wget
curl -X POST https://api.devbank.apiture.com/apiEnvironments/activeEnvironments?environment=string \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.devbank.apiture.com/apiEnvironments/activeEnvironments?environment=string HTTP/1.1
Host: api.devbank.apiture.com
Accept: application/hal+json
If-Match: string

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.devbank.apiture.com/apiEnvironments/activeEnvironments?environment=string',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

var headers = {
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.devbank.apiture.com/apiEnvironments/activeEnvironments',
  method: 'post',
  data: '?environment=string',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'If-Match' => 'string',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.devbank.apiture.com/apiEnvironments/activeEnvironments',
  params: {
  'environment' => 'string'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'If-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.devbank.apiture.com/apiEnvironments/activeEnvironments', params={
  'environment': 'string'
}, headers = headers)

print r.json()

URL obj = new URL("https://api.devbank.apiture.com/apiEnvironments/activeEnvironments?environment=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        "If-Match": []string{"string"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.devbank.apiture.com/apiEnvironments/activeEnvironments", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Activate an environment

POST https://api.devbank.apiture.com/apiEnvironments/activeEnvironments

Update an environment by adding it to the set of active environments. This changes the state property of the environment to active. This operation is available via the apiture:activate link on the environment resource, if and only if the environment is eligible for the activate operation. The responses is the updated representation of the environment. The If-Match required request header value must match the current entity tag value of the environment.

Parameters

Example responses

200 Response

{
  "_profile": "https://production.api.apiture.com/schemas/apiEnvironments/environment/v1.0.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "name": "DevBank",
  "description": "The sample runtime environment attached to the developer portal.",
  "host": "api.devbank.apiture.com",
  "authenticationParameters": {
    "identityGroupId": "63438dc44d3e949befcb7f6c2411"
  },
  "domains": [
    "apiture.com"
  ],
  "state": "active"
}

Responses

Schemas

abstractRequest

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractRequest/v2.0.0/profile.json",
  "_links": {}
}

Abstract Request (v2.0.0)

An abstract schema used to define other request-only schemas. This is a HAL resource representation, minus the _error defined in abstractResource.

This schema was resolved from common/abstractRequest.

Properties

abstractResource

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  }
}

Abstract Resource (v2.1.0)

An abstract schema used to define other schemas for request and response bodies. This is a HAL resource representation. This model contains hypermedia _links, and either optional domain object data with _profile and optional _embedded objects, or an _error object. In responses, if the operation was successful, this object will not include the _error, but if the operation was a 4xx or 5xx error, this object will not include _embedded or any data fields, only _error and optionally _links.

This schema was resolved from common/abstractResource.

Properties

allowedEnvironmentTypes

{
  "_profile": "https://production.api.apiture.com/schemas/apiEnvironments/allowedEnvironmentTypes/v1.0.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "types": [
    "development",
    "demo",
    "qualityAssurance",
    "uat"
  ]
}

Allowed Environment Types (v1.0.1)

A list of allowed environment types supported in this DevPortal instance.

Properties

attributes

{}

Attributes (v2.1.0)

An optional map of name/value pairs which contains additional dynamic data about the resource.

This schema was resolved from common/attributes.

Properties

authenticationParameters

{
  "clientId": "string",
  "identityGroupId": "string"
}

Open ID Connect (v1.0.0)

Information necessary for end users to authenticate with the identity provider.

Properties

cursorPagedCollection

{
  "_profile": "https://production.api.apiture.com/schemas/common/abstractResource/v2.1.0/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  }
}

Cursor Paged Collection (v2.1.1)

A collection of resources, or a page from a larger collection. This is an abstract model schema which is extended to define specific resource collections. Pages are referenced using an opaque string starting point named start. The _links in the collection may contain pagination links:

• the next link returns the next page of items. If there is no next link, the collection has been exhausted.
• the first link returns to the beginning of the filtered/sorted collection.
• the collection link returns to the beginning of the default collection with no explicit filter or sort criteria.

Cursor paged collections can only paginate forwards contiguously (without skipping items or pages), or reset to the beginning of the collection. This pagination works for collections which are likely to change during pagination, such as adding data to the beginning of the collection's natural sort order. Examples include transactions or audit records.

This schema was resolved from common/cursorPagedCollection.

Properties

environment

{
  "_profile": "https://production.api.apiture.com/schemas/apiEnvironments/environment/v1.0.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
  "name": "DevBank",
  "description": "The sample runtime environment attached to the developer portal.",
  "host": "api.devbank.apiture.com",
  "authenticationParameters": {
    "identityGroupId": "63438dc44d3e949befcb7f6c2411"
  },
  "domains": [
    "apiture.com"
  ],
  "state": "active"
}

Environment (v1.0.1)

Representation of environment resources.

Links

Response and request bodies using this environment schema may contain the following links:

Properties

environmentState

"active"

Environment State (v1.0.0)

The state of an environment.

environmentState strings may have one of the following enumerated values:

type: string

enum values: pending, active, inactive

environmentType

"development"

Environment Type (v1.0.0)

The type of runtime environment this is. The default is development which indicates an internal development-only environment. test includes user acceptance test (UAT).

environmentType strings may have one of the following enumerated values:

type: string

enum values: development, demo, qualityAssurance, uat, partner, production

environments

{
  "_profile": "https://production.api.apiture.com/schemas/apiEnvironments/environments/v1.0.1/profile.json",
  "_links": {
    "self": {
      "href": "/apiEnvironments/environments?start=g434ljkf430&limit=10"
    },
    "next": {
      "href": "/apiEnvironments/environments?start=p4900sk3df9&limit=10"
    },
    "collection": {
      "href": "/apiEnvironments/environments"
    }
  },
  "start": "g434ljkf430",
  "limit": 10,
  "name": "environments",
  "_embedded": {
    "items": [
      {
        "_id": "0399abed-fd3d-4830-a88b-30f38b8a365c",
        "name": "DevBank",
        "host": "api.devbank.apiture.com",
        "domains": [],
        "state": "active",
        "type": "development",
        "_profile": "https://production.api.apiture.com/schemas/apiEnvironments/environment/v1.0.1/profile.json",
        "_links": {
          "self": {
            "href": "/apiEnvironments/environments/0399abed-fd3d-4830-a88b-30f38b8a365c"
          },
          "apiture:webApplication": {
            "href": "https://devbank.apiture.com/"
          }
        }
      },
      {
        "_id": "d62c0701-0d74-4836-83f9-ebf3709442ea",
        "_profile": "https://production.api.apiture.com/schemas/apiEnvironments/environment/v1.0.1/profile.json",
        "name": "Team5",
        "host": "api.open-sandbox-team5.apiture.com",
        "domains": [
          "apiture.com",
          "apitureqa.com"
        ],
        "state": "active",
        "type": "development",
        "_links": {
          "self": {
            "href": "/apiEnvironments/environments/d62c0701-0d74-4836-83f9-ebf3709442ea"
          },
          "apiture:webApplication": {
            "href": "https://open-sandbox-team5.apiture.com"
          }
        }
      }
    ]
  }
}

Environment Collection (v1.0.1)

Collection of environments. The items in the collection are ordered in the _embedded.items array; the name is environments. The top-level _links object may contain pagination links: self, next, prev, first, last, collection..

Properties

error

{
  "_id": "2eae46e1575c0a7b0115a4b3",
  "message": "Descriptive error message...",
  "statusCode": 422,
  "type": "errorType1",
  "remediation": "Remediation string...",
  "occurredAt": "2018-01-25T05:50:52.375Z",
  "errors": [
    {
      "_id": "ccdbe2c5c938a230667b3827",
      "message": "An optional embedded error"
    },
    {
      "_id": "dbe9088dcfe2460f229338a3",
      "message": "Another optional embedded error"
    }
  ],
  "_links": {
    "describedby": {
      "href": "https://developer.apiture.com/errors/errorType1"
    }
  }
}

Error (v2.1.0)

Describes an error in an API request or in a service called via the API.

This schema was resolved from common/error.

Properties

errorResponse

{
  "_profile": "https://production.api.apiture.com/schemas/common/errorResponse/v2.1.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "_error": {
    "_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
    "message": "Description of the error will appear here.",
    "statusCode": 422,
    "type": "specificErrorType",
    "attributes": {
      "value": "Optional attribute describing the error"
    },
    "remediation": "Optional instructions to remediate the error may appear here.",
    "occurredAt": "2018-01-25T05:50:52.375Z",
    "_links": {
      "describedby": {
        "href": "https://production.api.apiture.com/errors/specificErrorType"
      }
    },
    "_embedded": {
      "errors": []
    }
  }
}

Error Response (v2.1.1)

Describes an error response, typically returned on 4xx or 5xx errors from API operations. The _error object contains the error details.

This schema was resolved from common/errorResponse.

Properties

link

{
  "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
  "title": "Application"
}

Link (v1.0.0)

Describes a hypermedia link within a _links object in HAL representations. In Apiture APIs, links are HAL links, but Apiture APIs do not use the name or hreflang properties of HAL. Apiture links may include a method property.

This schema was resolved from common/link.

Properties

links

{
  "property1": {
    "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
    "title": "Application"
  },
  "property2": {
    "href": "https://api.devbank.apiture.com/applications/application/328f6bf6-d762-422f-a077-ab91ca4d0b6f",
    "title": "Application"
  }
}

Links (v1.0.0)

An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.

This schema was resolved from common/links.

Properties

productLine

"open"

Product Line (v1.0.0)

The product line, for separating Open APIs and products from ADB APIs and products.

productLine strings may have one of the following enumerated values:

This schema was resolved from apiProducts/productLine.

type: string

default: "open"
enum values: open, adb

root

{
  "_profile": "https://production.api.apiture.com/schemas/common/root/v2.1.1/profile.json",
  "_links": {
    "self": {
      "href": "https://api.devbank.apiture.com/apiName/resourceName/resourceId"
    }
  },
  "id": "apiName",
  "name": "API name",
  "apiVersion": "1.0.0"
}

API Root (v2.1.1)

A HAL response, with hypermedia _links for the top-level resources and operations in API.

This schema was resolved from common/root.

Properties