fastly.IamServiceGroupsApi

Note

All URIs are relative to https://api.fastly.com

Method	HTTP request	Description
add_service_group_services	POST /service-groups/{service_group_id}/services	Add services in a service group
create_a_service_group	POST /service-groups	Create a service group
delete_a_service_group	DELETE /service-groups/{service_group_id}	Delete a service group
get_a_service_group	GET /service-groups/{service_group_id}	Get a service group
list_service_group_services	GET /service-groups/{service_group_id}/services	List services to a service group
list_service_groups	GET /service-groups	List service groups
remove_service_group_services	DELETE /service-groups/{service_group_id}/services	Remove services from a service group
update_a_service_group	PATCH /service-groups/{service_group_id}	Update a service group

add_service_group_services

{str: (bool, date, datetime, dict, float, int, list, str, none_type)} add_service_group_services(service_group_id)

Add services in a service group

Add services in a service group.

Example

Api Key Authentication (token):

import time
import fastly
from fastly.api import iam_service_groups_api
from pprint import pprint
# Defining the host is optional and defaults to https://api.fastly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = fastly.Configuration(
    host = "https://api.fastly.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: token
configuration.api_key['token'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['token'] = 'Bearer'

# Enter a context with an instance of the API client
with fastly.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = iam_service_groups_api.IamServiceGroupsApi(api_client)
    service_group_id = "t4Gg2uUGZzb2W9Euo4mo0R" # str | Alphanumeric string identifying the service group.
    request_body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} |  (optional)

    # example passing only required values which don't have defaults set
    try:
        # Add services in a service group
        api_response = api_instance.add_service_group_services(service_group_id)
        pprint(api_response)
    except fastly.ApiException as e:
        print("Exception when calling IamServiceGroupsApi->add_service_group_services: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Add services in a service group
        api_response = api_instance.add_service_group_services(service_group_id, request_body=request_body)
        pprint(api_response)
    except fastly.ApiException as e:
        print("Exception when calling IamServiceGroupsApi->add_service_group_services: %s\n" % e)

Parameters

Name	Type	Description	Notes
service_group_id	str	Alphanumeric string identifying the service group.
request_body	{str: (bool, date, datetime, dict, float, int, list, str, none_type)}		[optional]

Return type

{str: (bool, date, datetime, dict, float, int, list, str, none_type)}

Authorization

token

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Created	-

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

create_a_service_group

{str: (bool, date, datetime, dict, float, int, list, str, none_type)} create_a_service_group()

Create a service group

Create a service group.

Example

Api Key Authentication (token):

import time
import fastly
from fastly.api import iam_service_groups_api
from pprint import pprint
# Defining the host is optional and defaults to https://api.fastly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = fastly.Configuration(
    host = "https://api.fastly.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: token
configuration.api_key['token'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['token'] = 'Bearer'

# Enter a context with an instance of the API client
with fastly.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = iam_service_groups_api.IamServiceGroupsApi(api_client)
    request_body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} |  (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Create a service group
        api_response = api_instance.create_a_service_group(request_body=request_body)
        pprint(api_response)
    except fastly.ApiException as e:
        print("Exception when calling IamServiceGroupsApi->create_a_service_group: %s\n" % e)

Parameters

Name	Type	Description	Notes
request_body	{str: (bool, date, datetime, dict, float, int, list, str, none_type)}		[optional]

Return type

{str: (bool, date, datetime, dict, float, int, list, str, none_type)}

Authorization

token

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Created	-

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

delete_a_service_group

delete_a_service_group(service_group_id)

Delete a service group

Delete a service group.

Example

Api Key Authentication (token):

import time
import fastly
from fastly.api import iam_service_groups_api
from pprint import pprint
# Defining the host is optional and defaults to https://api.fastly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = fastly.Configuration(
    host = "https://api.fastly.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: token
configuration.api_key['token'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['token'] = 'Bearer'

# Enter a context with an instance of the API client
with fastly.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = iam_service_groups_api.IamServiceGroupsApi(api_client)
    service_group_id = "t4Gg2uUGZzb2W9Euo4mo0R" # str | Alphanumeric string identifying the service group.

    # example passing only required values which don't have defaults set
    try:
        # Delete a service group
        api_instance.delete_a_service_group(service_group_id)
    except fastly.ApiException as e:
        print("Exception when calling IamServiceGroupsApi->delete_a_service_group: %s\n" % e)

Parameters

Name	Type	Description	Notes
service_group_id	str	Alphanumeric string identifying the service group.

Return type

void (empty response body)

Authorization

token

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	No Content	-

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

get_a_service_group

{str: (bool, date, datetime, dict, float, int, list, str, none_type)} get_a_service_group(service_group_id)

Get a service group

Get a service group.

Example

Api Key Authentication (token):

import time
import fastly
from fastly.api import iam_service_groups_api
from pprint import pprint
# Defining the host is optional and defaults to https://api.fastly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = fastly.Configuration(
    host = "https://api.fastly.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: token
configuration.api_key['token'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['token'] = 'Bearer'

# Enter a context with an instance of the API client
with fastly.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = iam_service_groups_api.IamServiceGroupsApi(api_client)
    service_group_id = "t4Gg2uUGZzb2W9Euo4mo0R" # str | Alphanumeric string identifying the service group.

    # example passing only required values which don't have defaults set
    try:
        # Get a service group
        api_response = api_instance.get_a_service_group(service_group_id)
        pprint(api_response)
    except fastly.ApiException as e:
        print("Exception when calling IamServiceGroupsApi->get_a_service_group: %s\n" % e)

Parameters

Name	Type	Description	Notes
service_group_id	str	Alphanumeric string identifying the service group.

Return type

{str: (bool, date, datetime, dict, float, int, list, str, none_type)}

Authorization

token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

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

list_service_group_services

{str: (bool, date, datetime, dict, float, int, list, str, none_type)} list_service_group_services(service_group_id)

List services to a service group

List services to a service group.

Example

Api Key Authentication (token):

import time
import fastly
from fastly.api import iam_service_groups_api
from pprint import pprint
# Defining the host is optional and defaults to https://api.fastly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = fastly.Configuration(
    host = "https://api.fastly.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: token
configuration.api_key['token'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['token'] = 'Bearer'

# Enter a context with an instance of the API client
with fastly.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = iam_service_groups_api.IamServiceGroupsApi(api_client)
    service_group_id = "t4Gg2uUGZzb2W9Euo4mo0R" # str | Alphanumeric string identifying the service group.
    per_page = 20 # int | Number of records per page. (optional) if omitted the server will use the default value of 20
    page = 1 # int | Current page. (optional)

    # example passing only required values which don't have defaults set
    try:
        # List services to a service group
        api_response = api_instance.list_service_group_services(service_group_id)
        pprint(api_response)
    except fastly.ApiException as e:
        print("Exception when calling IamServiceGroupsApi->list_service_group_services: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # List services to a service group
        api_response = api_instance.list_service_group_services(service_group_id, per_page=per_page, page=page)
        pprint(api_response)
    except fastly.ApiException as e:
        print("Exception when calling IamServiceGroupsApi->list_service_group_services: %s\n" % e)

Parameters

Name	Type	Description	Notes
service_group_id	str	Alphanumeric string identifying the service group.
per_page	int	Number of records per page.	[optional] if omitted the server will use the default value of 20
page	int	Current page.	[optional]

Return type

{str: (bool, date, datetime, dict, float, int, list, str, none_type)}

Authorization

token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

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

list_service_groups

{str: (bool, date, datetime, dict, float, int, list, str, none_type)} list_service_groups()

List service groups

List all service groups.

Example

Api Key Authentication (token):

import time
import fastly
from fastly.api import iam_service_groups_api
from pprint import pprint
# Defining the host is optional and defaults to https://api.fastly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = fastly.Configuration(
    host = "https://api.fastly.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: token
configuration.api_key['token'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['token'] = 'Bearer'

# Enter a context with an instance of the API client
with fastly.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = iam_service_groups_api.IamServiceGroupsApi(api_client)
    per_page = 20 # int | Number of records per page. (optional) if omitted the server will use the default value of 20
    page = 1 # int | Current page. (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # List service groups
        api_response = api_instance.list_service_groups(per_page=per_page, page=page)
        pprint(api_response)
    except fastly.ApiException as e:
        print("Exception when calling IamServiceGroupsApi->list_service_groups: %s\n" % e)

Parameters

Name	Type	Description	Notes
per_page	int	Number of records per page.	[optional] if omitted the server will use the default value of 20
page	int	Current page.	[optional]

Return type

{str: (bool, date, datetime, dict, float, int, list, str, none_type)}

Authorization

token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

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

remove_service_group_services

remove_service_group_services(service_group_id)

Remove services from a service group

Remove services from a service group.

Example

Api Key Authentication (token):

import time
import fastly
from fastly.api import iam_service_groups_api
from pprint import pprint
# Defining the host is optional and defaults to https://api.fastly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = fastly.Configuration(
    host = "https://api.fastly.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: token
configuration.api_key['token'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['token'] = 'Bearer'

# Enter a context with an instance of the API client
with fastly.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = iam_service_groups_api.IamServiceGroupsApi(api_client)
    service_group_id = "t4Gg2uUGZzb2W9Euo4mo0R" # str | Alphanumeric string identifying the service group.
    request_body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} |  (optional)

    # example passing only required values which don't have defaults set
    try:
        # Remove services from a service group
        api_instance.remove_service_group_services(service_group_id)
    except fastly.ApiException as e:
        print("Exception when calling IamServiceGroupsApi->remove_service_group_services: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Remove services from a service group
        api_instance.remove_service_group_services(service_group_id, request_body=request_body)
    except fastly.ApiException as e:
        print("Exception when calling IamServiceGroupsApi->remove_service_group_services: %s\n" % e)

Parameters

Name	Type	Description	Notes
service_group_id	str	Alphanumeric string identifying the service group.
request_body	{str: (bool, date, datetime, dict, float, int, list, str, none_type)}		[optional]

Return type

void (empty response body)

Authorization

token

HTTP request headers

Content-Type: application/json
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	No Content	-

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

update_a_service_group

{str: (bool, date, datetime, dict, float, int, list, str, none_type)} update_a_service_group(service_group_id)

Update a service group

Update a service group.

Example

Api Key Authentication (token):

import time
import fastly
from fastly.api import iam_service_groups_api
from pprint import pprint
# Defining the host is optional and defaults to https://api.fastly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = fastly.Configuration(
    host = "https://api.fastly.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: token
configuration.api_key['token'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['token'] = 'Bearer'

# Enter a context with an instance of the API client
with fastly.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = iam_service_groups_api.IamServiceGroupsApi(api_client)
    service_group_id = "t4Gg2uUGZzb2W9Euo4mo0R" # str | Alphanumeric string identifying the service group.
    request_body = {} # {str: (bool, date, datetime, dict, float, int, list, str, none_type)} |  (optional)

    # example passing only required values which don't have defaults set
    try:
        # Update a service group
        api_response = api_instance.update_a_service_group(service_group_id)
        pprint(api_response)
    except fastly.ApiException as e:
        print("Exception when calling IamServiceGroupsApi->update_a_service_group: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Update a service group
        api_response = api_instance.update_a_service_group(service_group_id, request_body=request_body)
        pprint(api_response)
    except fastly.ApiException as e:
        print("Exception when calling IamServiceGroupsApi->update_a_service_group: %s\n" % e)

Parameters

Name	Type	Description	Notes
service_group_id	str	Alphanumeric string identifying the service group.
request_body	{str: (bool, date, datetime, dict, float, int, list, str, none_type)}		[optional]

Return type

{str: (bool, date, datetime, dict, float, int, list, str, none_type)}

Authorization

token

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

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

Files

IamServiceGroupsApi.md

Latest commit

History

IamServiceGroupsApi.md

File metadata and controls

fastly.IamServiceGroupsApi

add_service_group_services

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_a_service_group

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_a_service_group

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_a_service_group

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_service_group_services

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_service_groups

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

remove_service_group_services

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_a_service_group

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details