Skip to content

Latest commit

 

History

History
672 lines (481 loc) · 28.1 KB

IntentApplicationPolicyApi.md

File metadata and controls

672 lines (481 loc) · 28.1 KB

dnac_api_client.IntentApplicationPolicyApi

All URIs are relative to http://localhost

Method HTTP request Description
dna_intent_api_v1_application_count_get GET /dna/intent/api/v1/application/count Get Applications Count
dna_intent_api_v1_application_policy_get GET /dna/intent/api/v1/application-policy Get Application Policies
dna_intent_api_v1_application_set_count_get GET /dna/intent/api/v1/application-set/count Get Application Sets Count
dna_intent_api_v1_application_sets_get GET /dna/intent/api/v1/application-sets Get Application Sets
dna_intent_api_v1_applications_get GET /dna/intent/api/v1/applications Get Applications
dna_intent_api_v1_create_application_policy_post POST /dna/intent/api/v1/create-application-policy Post Application Policy Intent
dna_intent_api_v1_create_application_post POST /dna/intent/api/v1/create-application Post Application
dna_intent_api_v1_create_application_set_post POST /dna/intent/api/v1/create-application-set Post Application Set
dna_intent_api_v1_delete_application_delete DELETE /dna/intent/api/v1/delete-application Delete Application
dna_intent_api_v1_delete_application_set_delete DELETE /dna/intent/api/v1/delete-application-set Delete Application Set
dna_intent_api_v1_update_application_put PUT /dna/intent/api/v1/update-application Edit Application

dna_intent_api_v1_application_count_get

dna_intent_api_v1_application_count_get(count, runsync=runsync, timeout=timeout)

Get Applications Count

Invoke the API to return the number of defined applications

Example

  • Api Key Authentication (APIKeyHeader):
from __future__ import print_function
import time
import dnac_api_client
from dnac_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: APIKeyHeader
configuration = dnac_api_client.Configuration()
configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# create an instance of the API class
api_instance = dnac_api_client.IntentApplicationPolicyApi(dnac_api_client.ApiClient(configuration))
count = 'count_example' # str | 
runsync = False # bool | Enable this parameter to execute the API and return a response synchronously (optional) (default to False)
timeout = 10.0 # float | During synchronous execution, this defines the maximum time to wait for a response, before the API execution is terminated (optional) (default to 10.0)

try:
    # Get Applications Count
    api_instance.dna_intent_api_v1_application_count_get(count, runsync=runsync, timeout=timeout)
except ApiException as e:
    print("Exception when calling IntentApplicationPolicyApi->dna_intent_api_v1_application_count_get: %s\n" % e)

Parameters

Name Type Description Notes
count str
runsync bool Enable this parameter to execute the API and return a response synchronously [optional] [default to False]
timeout float During synchronous execution, this defines the maximum time to wait for a response, before the API execution is terminated [optional] [default to 10.0]

Return type

void (empty response body)

Authorization

APIKeyHeader

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

dna_intent_api_v1_application_policy_get

dna_intent_api_v1_application_policy_get(runsync=runsync, timeout=timeout, offset=offset, limit=limit, application_policy_namespace=application_policy_namespace)

Get Application Policies

Invoke the API to return all (or specific) application-policy(ies)

Example

  • Api Key Authentication (APIKeyHeader):
from __future__ import print_function
import time
import dnac_api_client
from dnac_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: APIKeyHeader
configuration = dnac_api_client.Configuration()
configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# create an instance of the API class
api_instance = dnac_api_client.IntentApplicationPolicyApi(dnac_api_client.ApiClient(configuration))
runsync = False # bool | Enable this parameter to execute the API and return a response synchronously (optional) (default to False)
timeout = 10.0 # float | During synchronous execution, this defines the maximum time to wait for a response, before the API execution is terminated (optional) (default to 10.0)
offset = 1.0 # float |  (optional) (default to 1.0)
limit = 500.0 # float |  (optional) (default to 500.0)
application_policy_namespace = 'application_policy_namespace_example' # str |  (optional)

try:
    # Get Application Policies
    api_instance.dna_intent_api_v1_application_policy_get(runsync=runsync, timeout=timeout, offset=offset, limit=limit, application_policy_namespace=application_policy_namespace)
except ApiException as e:
    print("Exception when calling IntentApplicationPolicyApi->dna_intent_api_v1_application_policy_get: %s\n" % e)

Parameters

Name Type Description Notes
runsync bool Enable this parameter to execute the API and return a response synchronously [optional] [default to False]
timeout float During synchronous execution, this defines the maximum time to wait for a response, before the API execution is terminated [optional] [default to 10.0]
offset float [optional] [default to 1.0]
limit float [optional] [default to 500.0]
application_policy_namespace str [optional]

Return type

void (empty response body)

Authorization

APIKeyHeader

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

dna_intent_api_v1_application_set_count_get

dna_intent_api_v1_application_set_count_get(count, runsync=runsync, timeout=timeout)

Get Application Sets Count

Invoke the API to return the number of defined application sets

Example

  • Api Key Authentication (APIKeyHeader):
from __future__ import print_function
import time
import dnac_api_client
from dnac_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: APIKeyHeader
configuration = dnac_api_client.Configuration()
configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# create an instance of the API class
api_instance = dnac_api_client.IntentApplicationPolicyApi(dnac_api_client.ApiClient(configuration))
count = 'count_example' # str | 
runsync = False # bool | Enable this parameter to execute the API and return a response synchronously (optional) (default to False)
timeout = 10.0 # float | During synchronous execution, this defines the maximum time to wait for a response, before the API execution is terminated (optional) (default to 10.0)

try:
    # Get Application Sets Count
    api_instance.dna_intent_api_v1_application_set_count_get(count, runsync=runsync, timeout=timeout)
except ApiException as e:
    print("Exception when calling IntentApplicationPolicyApi->dna_intent_api_v1_application_set_count_get: %s\n" % e)

Parameters

Name Type Description Notes
count str
runsync bool Enable this parameter to execute the API and return a response synchronously [optional] [default to False]
timeout float During synchronous execution, this defines the maximum time to wait for a response, before the API execution is terminated [optional] [default to 10.0]

Return type

void (empty response body)

Authorization

APIKeyHeader

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

dna_intent_api_v1_application_sets_get

dna_intent_api_v1_application_sets_get(runsync=runsync, timeout=timeout, offset=offset, limit=limit, application_set_name=application_set_name)

Get Application Sets

Invoke the API to return all (or specific) defined application-set(s)

Example

  • Api Key Authentication (APIKeyHeader):
from __future__ import print_function
import time
import dnac_api_client
from dnac_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: APIKeyHeader
configuration = dnac_api_client.Configuration()
configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# create an instance of the API class
api_instance = dnac_api_client.IntentApplicationPolicyApi(dnac_api_client.ApiClient(configuration))
runsync = False # bool | Enable this parameter to execute the API and return a response synchronously (optional) (default to False)
timeout = 10.0 # float | During synchronous execution, this defines the maximum time to wait for a response, before the API execution is terminated (optional) (default to 10.0)
offset = 1.0 # float |  (optional) (default to 1.0)
limit = 500.0 # float |  (optional) (default to 500.0)
application_set_name = 'application_set_name_example' # str |  (optional)

try:
    # Get Application Sets
    api_instance.dna_intent_api_v1_application_sets_get(runsync=runsync, timeout=timeout, offset=offset, limit=limit, application_set_name=application_set_name)
except ApiException as e:
    print("Exception when calling IntentApplicationPolicyApi->dna_intent_api_v1_application_sets_get: %s\n" % e)

Parameters

Name Type Description Notes
runsync bool Enable this parameter to execute the API and return a response synchronously [optional] [default to False]
timeout float During synchronous execution, this defines the maximum time to wait for a response, before the API execution is terminated [optional] [default to 10.0]
offset float [optional] [default to 1.0]
limit float [optional] [default to 500.0]
application_set_name str [optional]

Return type

void (empty response body)

Authorization

APIKeyHeader

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

dna_intent_api_v1_applications_get

dna_intent_api_v1_applications_get(runsync=runsync, timeout=timeout, offset=offset, limit=limit, application_name=application_name)

Get Applications

Invoke the API to return the list of all (or specific) defined application(s)

Example

  • Api Key Authentication (APIKeyHeader):
from __future__ import print_function
import time
import dnac_api_client
from dnac_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: APIKeyHeader
configuration = dnac_api_client.Configuration()
configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# create an instance of the API class
api_instance = dnac_api_client.IntentApplicationPolicyApi(dnac_api_client.ApiClient(configuration))
runsync = False # bool | Enable this parameter to execute the API and return a response synchronously (optional) (default to False)
timeout = 10.0 # float | During synchronous execution, this defines the maximum time to wait for a response, before the API execution is terminated (optional) (default to 10.0)
offset = 1.0 # float |  (optional) (default to 1.0)
limit = 500.0 # float |  (optional) (default to 500.0)
application_name = 'application_name_example' # str |  (optional)

try:
    # Get Applications
    api_instance.dna_intent_api_v1_applications_get(runsync=runsync, timeout=timeout, offset=offset, limit=limit, application_name=application_name)
except ApiException as e:
    print("Exception when calling IntentApplicationPolicyApi->dna_intent_api_v1_applications_get: %s\n" % e)

Parameters

Name Type Description Notes
runsync bool Enable this parameter to execute the API and return a response synchronously [optional] [default to False]
timeout float During synchronous execution, this defines the maximum time to wait for a response, before the API execution is terminated [optional] [default to 10.0]
offset float [optional] [default to 1.0]
limit float [optional] [default to 500.0]
application_name str [optional]

Return type

void (empty response body)

Authorization

APIKeyHeader

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

dna_intent_api_v1_create_application_policy_post

dna_intent_api_v1_create_application_policy_post(runsync=runsync, timeout=timeout)

Post Application Policy Intent

Invoke the API to create, modify or delete an application-policy

Example

  • Api Key Authentication (APIKeyHeader):
from __future__ import print_function
import time
import dnac_api_client
from dnac_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: APIKeyHeader
configuration = dnac_api_client.Configuration()
configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# create an instance of the API class
api_instance = dnac_api_client.IntentApplicationPolicyApi(dnac_api_client.ApiClient(configuration))
runsync = False # bool | Enable this parameter to execute the API and return a response synchronously (optional) (default to False)
timeout = 10.0 # float | During synchronous execution, this defines the maximum time to wait for a response, before the API execution is terminated (optional) (default to 10.0)

try:
    # Post Application Policy Intent
    api_instance.dna_intent_api_v1_create_application_policy_post(runsync=runsync, timeout=timeout)
except ApiException as e:
    print("Exception when calling IntentApplicationPolicyApi->dna_intent_api_v1_create_application_policy_post: %s\n" % e)

Parameters

Name Type Description Notes
runsync bool Enable this parameter to execute the API and return a response synchronously [optional] [default to False]
timeout float During synchronous execution, this defines the maximum time to wait for a response, before the API execution is terminated [optional] [default to 10.0]

Return type

void (empty response body)

Authorization

APIKeyHeader

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

dna_intent_api_v1_create_application_post

dna_intent_api_v1_create_application_post(runsync=runsync, timeout=timeout)

Post Application

Invoke the API to create a custom application

Example

  • Api Key Authentication (APIKeyHeader):
from __future__ import print_function
import time
import dnac_api_client
from dnac_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: APIKeyHeader
configuration = dnac_api_client.Configuration()
configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# create an instance of the API class
api_instance = dnac_api_client.IntentApplicationPolicyApi(dnac_api_client.ApiClient(configuration))
runsync = False # bool | Enable this parameter to execute the API and return a response synchronously (optional) (default to False)
timeout = 10.0 # float | During synchronous execution, this defines the maximum time to wait for a response, before the API execution is terminated (optional) (default to 10.0)

try:
    # Post Application
    api_instance.dna_intent_api_v1_create_application_post(runsync=runsync, timeout=timeout)
except ApiException as e:
    print("Exception when calling IntentApplicationPolicyApi->dna_intent_api_v1_create_application_post: %s\n" % e)

Parameters

Name Type Description Notes
runsync bool Enable this parameter to execute the API and return a response synchronously [optional] [default to False]
timeout float During synchronous execution, this defines the maximum time to wait for a response, before the API execution is terminated [optional] [default to 10.0]

Return type

void (empty response body)

Authorization

APIKeyHeader

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

dna_intent_api_v1_create_application_set_post

dna_intent_api_v1_create_application_set_post(runsync=runsync, timeout=timeout)

Post Application Set

Invoke the API to create a custom application set

Example

  • Api Key Authentication (APIKeyHeader):
from __future__ import print_function
import time
import dnac_api_client
from dnac_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: APIKeyHeader
configuration = dnac_api_client.Configuration()
configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# create an instance of the API class
api_instance = dnac_api_client.IntentApplicationPolicyApi(dnac_api_client.ApiClient(configuration))
runsync = False # bool | Enable this parameter to execute the API and return a response synchronously (optional) (default to False)
timeout = 10.0 # float | During synchronous execution, this defines the maximum time to wait for a response, before the API execution is terminated (optional) (default to 10.0)

try:
    # Post Application Set
    api_instance.dna_intent_api_v1_create_application_set_post(runsync=runsync, timeout=timeout)
except ApiException as e:
    print("Exception when calling IntentApplicationPolicyApi->dna_intent_api_v1_create_application_set_post: %s\n" % e)

Parameters

Name Type Description Notes
runsync bool Enable this parameter to execute the API and return a response synchronously [optional] [default to False]
timeout float During synchronous execution, this defines the maximum time to wait for a response, before the API execution is terminated [optional] [default to 10.0]

Return type

void (empty response body)

Authorization

APIKeyHeader

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

dna_intent_api_v1_delete_application_delete

dna_intent_api_v1_delete_application_delete(application_id, runsync=runsync, timeout=timeout)

Delete Application

Invoke the API to delete a custom application

Example

  • Api Key Authentication (APIKeyHeader):
from __future__ import print_function
import time
import dnac_api_client
from dnac_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: APIKeyHeader
configuration = dnac_api_client.Configuration()
configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# create an instance of the API class
api_instance = dnac_api_client.IntentApplicationPolicyApi(dnac_api_client.ApiClient(configuration))
application_id = 'application_id_example' # str | 
runsync = False # bool | Enable this parameter to execute the API and return a response synchronously (optional) (default to False)
timeout = 10.0 # float | During synchronous execution, this defines the maximum time to wait for a response, before the API execution is terminated (optional) (default to 10.0)

try:
    # Delete Application
    api_instance.dna_intent_api_v1_delete_application_delete(application_id, runsync=runsync, timeout=timeout)
except ApiException as e:
    print("Exception when calling IntentApplicationPolicyApi->dna_intent_api_v1_delete_application_delete: %s\n" % e)

Parameters

Name Type Description Notes
application_id str
runsync bool Enable this parameter to execute the API and return a response synchronously [optional] [default to False]
timeout float During synchronous execution, this defines the maximum time to wait for a response, before the API execution is terminated [optional] [default to 10.0]

Return type

void (empty response body)

Authorization

APIKeyHeader

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

dna_intent_api_v1_delete_application_set_delete

dna_intent_api_v1_delete_application_set_delete(application_set_id, runsync=runsync, timeout=timeout)

Delete Application Set

Invoke the API to delete a custom application

Example

  • Api Key Authentication (APIKeyHeader):
from __future__ import print_function
import time
import dnac_api_client
from dnac_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: APIKeyHeader
configuration = dnac_api_client.Configuration()
configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# create an instance of the API class
api_instance = dnac_api_client.IntentApplicationPolicyApi(dnac_api_client.ApiClient(configuration))
application_set_id = 'application_set_id_example' # str | 
runsync = False # bool | Enable this parameter to execute the API and return a response synchronously (optional) (default to False)
timeout = 10.0 # float | During synchronous execution, this defines the maximum time to wait for a response, before the API execution is terminated (optional) (default to 10.0)

try:
    # Delete Application Set
    api_instance.dna_intent_api_v1_delete_application_set_delete(application_set_id, runsync=runsync, timeout=timeout)
except ApiException as e:
    print("Exception when calling IntentApplicationPolicyApi->dna_intent_api_v1_delete_application_set_delete: %s\n" % e)

Parameters

Name Type Description Notes
application_set_id str
runsync bool Enable this parameter to execute the API and return a response synchronously [optional] [default to False]
timeout float During synchronous execution, this defines the maximum time to wait for a response, before the API execution is terminated [optional] [default to 10.0]

Return type

void (empty response body)

Authorization

APIKeyHeader

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

dna_intent_api_v1_update_application_put

dna_intent_api_v1_update_application_put(runsync=runsync, timeout=timeout)

Edit Application

Invoke the API to create a custom application

Example

  • Api Key Authentication (APIKeyHeader):
from __future__ import print_function
import time
import dnac_api_client
from dnac_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: APIKeyHeader
configuration = dnac_api_client.Configuration()
configuration.api_key['X-Auth-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Auth-Token'] = 'Bearer'

# create an instance of the API class
api_instance = dnac_api_client.IntentApplicationPolicyApi(dnac_api_client.ApiClient(configuration))
runsync = False # bool | Enable this parameter to execute the API and return a response synchronously (optional) (default to False)
timeout = 10.0 # float | During synchronous execution, this defines the maximum time to wait for a response, before the API execution is terminated (optional) (default to 10.0)

try:
    # Edit Application
    api_instance.dna_intent_api_v1_update_application_put(runsync=runsync, timeout=timeout)
except ApiException as e:
    print("Exception when calling IntentApplicationPolicyApi->dna_intent_api_v1_update_application_put: %s\n" % e)

Parameters

Name Type Description Notes
runsync bool Enable this parameter to execute the API and return a response synchronously [optional] [default to False]
timeout float During synchronous execution, this defines the maximum time to wait for a response, before the API execution is terminated [optional] [default to 10.0]

Return type

void (empty response body)

Authorization

APIKeyHeader

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]