This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Models

1: AccessControl
2: AccessControlCreateRequest
3: AccessControlCreateResponse
4: AccessControlListResponse
5: AccessControlSetRequest
6: AccessControlShowResponse
7: Api
8: ApiConnectedEndpoint
9: ApiConnectedEndpointListResponse
10: ApiCreateRequest
11: ApiCreateRequestV1Dot2
12: ApiCreateResponse
13: ApiDeployment
14: ApiDeploymentListResponse
15: ApiDeploymentRequest
16: ApiDeploymentResponse
17: ApiDetail
18: ApiKey
19: ApiKeyCreateRequest
20: ApiKeyInStage
21: ApiKeyListResponse
22: ApiKeySetDescriptionRequest
23: ApiKeyShowResponse
24: ApiListResponse
25: ApiSetDescriptionRequest
26: ApiShowResponse
27: Auth
28: AuthCreateRequest
29: AuthCreateResponse
30: AuthListResponse
31: AuthSetRequest
32: AuthShowResponse
33: Method
34: MethodCreateRequest
35: MethodCreateRequestV1Dot1
36: MethodInStage
37: MethodListResponse
38: MethodListResponseV1Dot1
39: MethodListResponseV1Dot2
40: MethodSetRequest
41: MethodSetRequestV1Dot1
42: MethodShowResponse
43: MethodShowResponseV1Dot1
44: MethodShowResponseV1Dot2
45: MethodV1Dot1
46: MethodV1Dot2
47: PrivateLinkEndpoint
48: PrivateLinkEndpointApprovalRequest
49: PrivateLinkEndpointConnectionRequest
50: PrivateLinkEndpointCreateRequest
51: PrivateLinkEndpointDetail
52: PrivateLinkEndpointListResponse
53: PrivateLinkEndpointRequestRequest
54: PrivateLinkEndpointSetRequest
55: PrivateLinkEndpointShowResponse
56: PrivateLinkEndpointSummary
57: PrivateLinkEndpointSummaryShowResponse
58: Report
59: ReportListResponse
60: Resource
61: ResourceCreateRequest
62: ResourceCreateResponse
63: ResourceListResponse
64: ResourceListResponseV1Dot1
65: ResourceListResponseV1Dot2
66: ResourceShowResponse
67: ResourceShowResponseV1Dot1
68: ResourceShowResponseV1Dot2
69: ResourceSummary
70: ResourceSummaryV1Dot1
71: ResourceV1Dot1
72: ResourceV1Dot2
73: Stage
74: StageCreateRequest
75: StageDetail
76: StageDetailV1Dot1
77: StageListResponse
78: StageListResponseV1Dot1
79: StageSetActiveDeploymentRequest
80: StageSetConfigRequest
81: StageSetConfigRequestV1Dot1
82: StageShowResponse
83: StageShowResponseV1Dot1
84: StageV1Dot1
85: Tag
86: TopResource
87: UsagePlan
88: UsagePlanCreateRequest
89: UsagePlanDetail
90: UsagePlanListResponse
91: UsagePlanSetDescriptionRequest
92: UsagePlanSetQuotaRequest
93: UsagePlanShowResponse

1 - AccessControl

Name	Description	Schema
allowed_ip_addr required	Allowed IP Address Example : `['127.0.0.1/24,192.168.127.12']`	array[string]
connected_stages required	Connected Stages Example : `['dev,stg']`	array[string]
created_at required	Creation Date Example : `2024-05-19T00:23:17Z`	string (date-time)
description required	Description Example :	string
id required	Access Control ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
name required	Access Control Name Example : `DenyTest`	string

2 - AccessControlCreateRequest

Name	Description	Schema
allowed_ip_addr required	Allowed IP Address Example : `['127.0.0.1/24,192.168.127.12']`	array[string]
connected_stages required	Connected Stages Example : `['dev,stg']`	any of [array[string], null]
description optional	Description Example : `description`	any of [string, null]
name required	Access Control Name Example : `DenyTest` Pattern : `^[a-z][a-z0-9\-]{1,48}[a-z0-9]$` Minimum length : `3` Maximum length : `50`	string

3 - AccessControlCreateResponse

Name	Description	Schema
allowed_ip_addr required	Allowed IP Address Example : `['127.0.0.1/24,192.168.127.12']`	array[string]
connected_stages required	Connected Stages Example : `['dev,stg']`	array[string]
created_at required	Creation Date Example : `2024-05-19T00:23:17Z`	string (date-time)
description required	Description Example :	string
id required	Access Control ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
name required	Access Control Name Example : `DenyTest`	string

4 - AccessControlListResponse

Name	Description	Schema	Default
access_controls required		array[AccessControl]
count required	Total Count Example : `20`	integer

5 - AccessControlSetRequest

Name	Description	Schema
allowed_ip_addr required	Allowed IP Address Example : `['127.0.0.1/24,192.168.127.12']`	array[string]
connected_stages required	Connected Stages Example : `['dev,stg']`	any of [array[string], null]
description optional	Description Example : `description`	any of [string, null]

6 - AccessControlShowResponse

Name	Description	Schema	Default
access_control required		AccessControl

7 - Api

Name	Description	Schema
account_id required	Account ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
created_at required	Creation Date Example : `2024-05-17T00:23:17Z`	string (date-time)
description required	Description Example : `Description`	string
dns_record_status optional	DNS Record Status Example : `Active`	any of [string, null]
id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
name required	Name Example : `test-api`	string
status required	Api Status Example : `Active`	string

8 - ApiConnectedEndpoint

Name	Description	Schema
created_at required	Creation Date Example : `2024-05-17T00:23:17Z`	string (date-time)
id required	PrivateLink Endpoint ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
status required	PrivateLink Endpoint Status Example : `Active`	string

9 - ApiConnectedEndpointListResponse

Name	Description	Schema	Default
connected_endpoints required		array[ApiConnectedEndpoint]
count required	Total Count Example : `20`	integer

10 - ApiCreateRequest

Name	Description	Schema
description optional	Description Example : `description`	any of [string, null]
id optional	Api ID Example :	any of [string, null]
name required	Name Example : `test-api` Pattern : `^[a-z][a-z0-9\-]{1,48}[a-z0-9]$` Minimum length : `3` Maximum length : `50`	string
tags optional	Tag List	any of [array[Tag], null]

11 - ApiCreateRequestV1Dot2

Name	Description	Schema	Default
description optional	Description Example : `description`	any of [string, null]
endpoint_type optional	Endpoint Type Example : `REGION`	enum (REGION, PRIVATE)	REGION
id optional	Api ID Example :	any of [string, null]
name required	Name Example : `test-api` Pattern : `^[a-z][a-z0-9\-]{1,48}[a-z0-9]$` Minimum length : `3` Maximum length : `50`	string
tags optional	Tag List	any of [array[Tag], null]

12 - ApiCreateResponse

Name	Description	Schema
description required	Description Example : `Description`	string
id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
name required	Name Example : `test-api`	string

13 - ApiDeployment

Name	Description	Schema	Default
deployment_date required	Deployment Date Example : `2024-05-17T00:23:17Z`	string (date-time)
deployment_id required	Deployment ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
description required	Description Example : `description`	string
status optional	Status Example : `Active`	string	-

14 - ApiDeploymentListResponse

Name	Description	Schema	Default
count required	Total Count Example : `20`	integer
deployments required		array[ApiDeployment]

15 - ApiDeploymentRequest

Name	Description	Schema
description optional	Description Example : `description`	any of [string, null]
stage_name optional	Stage Name Example : `test-stage`	any of [string, null]
stage_type required	Stage Type Example : `new`	enum (new, existing, none)

16 - ApiDeploymentResponse

Name	Description	Schema	Default
deployment_id required	Deployment ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
description optional	Description Example : `description`	any of [string, null]

17 - ApiDetail

Name	Description	Schema
account_id required	Account ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
created_at required	Creation Date Example : `2024-05-17T00:23:17Z`	string (date-time)
description required	Description Example : `Description`	string
dns_record_status optional	DNS Record Status Example : `Active`	any of [string, null]
id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
name required	Name Example : `test-api`	string
status required	Api Status Example : `Active`	string

18 - ApiKey

Name	Description	Schema
created_at required	Creation Date Example :	string (date-time)
description optional	Description Example : `description`	string
id required	API Key ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
key required	Key Example : `key`	string
name required	Name Example : `api-key-name`	string

19 - ApiKeyCreateRequest

Name	Description	Schema	Default
description optional	Description Example : `description`	any of [string, null]
name required	Name Example : `api-key-name` Pattern : `^[a-z][a-z0-9\-]{1,48}[a-z0-9]$` Minimum length : `3` Maximum length : `50`	string

20 - ApiKeyInStage

Name	Description	Schema	Default
id required	API Key ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
name required	Name Example : `api-key-name`	string

21 - ApiKeyListResponse

Name	Description	Schema	Default
api_keys required		array[ApiKey]
count required	Total Count Example : `20`	integer

22 - ApiKeySetDescriptionRequest

Name	Description	Schema	Default
description optional	Description Example : `description`	any of [string, null]

23 - ApiKeyShowResponse

Name	Description	Schema	Default
api_key required		ApiKey

24 - ApiListResponse

Name	Description	Schema	Default
apis required		array[Api]
count required	Total Count Example : `20`	integer

25 - ApiSetDescriptionRequest

Name	Description	Schema	Default
description optional	Description Example : `description`	any of [string, null]

26 - ApiShowResponse

Name	Description	Schema	Default
api required		ApiDetail

27 - Auth

Name	Description	Schema	Default
auth_method optional	AUTH Method Example : `JWT(JSON WEB Token)`	string	JWT(JSON WEB Token)
connected_stages required	Connected Stages Example : `['dev,stg']`	array[string]
expired_at required	Expiration Date Example : `2024-05-17T00:23:17Z`	string (date-time)
id required	Auth ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
name required	Auth NAME Example : `Token01`	string

28 - AuthCreateRequest

Name	Description	Schema
connected_stages required	Connected Stages Example : `['dev,stg']`	any of [array[string], null]
expiration_period required	Expiration Period Example : `90`	integer
name required	Auth NAME Example : `Token01` Pattern : `^[a-z][a-z0-9\-]{1,48}[a-z0-9]$` Minimum length : `3` Maximum length : `50`	string

29 - AuthCreateResponse

Name	Description	Schema	Default
access_token required	Access Token Example : `***********************************************************`	string

30 - AuthListResponse

Name	Description	Schema	Default
auths required		array[Auth]
count required	Total Count Example : `20`	integer

31 - AuthSetRequest

Name	Description	Schema	Default
connected_stages required	Connected Stages Example : `['dev,stg']`	any of [array[string], null]

32 - AuthShowResponse

Name	Description	Schema	Default
auth required		Auth

33 - Method

Name	Description	Schema
endpoint_url optional	Method Endpoint URL Example : `https://127.0.0.1:8000`	any of [string, null]
function_id optional	Cloud Function ID Example : `27bb070b564349f8a31cc60734cc36a5`	any of [string, null]
integration_type required	Method Integration Type Example : `HTTP`	string
method_type required	Method Type Example : `GET`	string
query_strings optional	Method Query Strings Example : `{'param1': 'value1', 'param2': 'value2'}`	any of [object[boolean], null]
request_headers optional	Method Request Headers Example : `{'test1' : True}`	any of [object[boolean], null]
request_path optional	Method Request Path Example : `{users}`	any of [array[object], null]
srn required	SRN Example : `srn:dev2::9b7653f6f47a42e38055934a0575a813:kr-west1::apiateway:method/151a6c15922747faaaae7f70/*/GET/test`	string

34 - MethodCreateRequest

Name	Description	Schema
api_key_required optional	Api Key Required Example : `False`	any of [boolean, null]
endpoint_url optional	Method Endpoint URL Example : `https://127.0.0.1:8000`	any of [string, null]
function_id optional	Cloud Function ID Example : `27bb070b564349f8a31cc60734cc36a5`	any of [string, null]
integration_type required	Method Integration Type Example : `HTTP`	enum (HTTP, SCF, PRIVATELINK)
method_type required	Method Type Example : `GET`	enum (GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS, ANY)
privatelink_endpoint_id optional	PrivateLink Endpoint ID Example : `27bb070b564349f8a31cc60734cc36a5`	any of [string, null]
query_strings optional	Method Query Strings Example : `{'param1': 'value1', 'param2': 'value2'}`	any of [object[boolean], null]
request_headers optional	Method Request Headers Example : `{'test1' : True}`	any of [object[boolean], null]

35 - MethodCreateRequestV1Dot1

Name	Description	Schema
api_key_required optional	Api Key Required Example : `False`	any of [boolean, null]
endpoint_url optional	Method Endpoint URL Example : `https://127.0.0.1:8000`	any of [string, null]
function_id optional	Cloud Function ID Example : `27bb070b564349f8a31cc60734cc36a5`	any of [string, null]
integration_type required	Method Integration Type Example : `HTTP`	enum (HTTP, SCF, PRIVATELINK)
method_type required	Method Type Example : `GET`	enum (GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS, ANY)
privatelink_endpoint_id optional	PrivateLink Endpoint ID Example : `27bb070b564349f8a31cc60734cc36a5`	any of [string, null]
query_strings optional	Method Query Strings Example : `{'param1': 'value1', 'param2': 'value2'}`	any of [object[boolean], null]
request_headers optional	Method Request Headers Example : `{'test1' : True}`	any of [object[boolean], null]

36 - MethodInStage

Name	Description	Schema	Default
api_key_required optional	Api Key Required Example : `False`	boolean
type required	Method Type Example : `GET`	string

37 - MethodListResponse

Name	Description	Schema	Default
methods required		array[Method]

38 - MethodListResponseV1Dot1

Name	Description	Schema	Default
methods required		array[MethodV1Dot1]

39 - MethodListResponseV1Dot2

Name	Description	Schema	Default
methods required		array[MethodV1Dot2]

40 - MethodSetRequest

Name	Description	Schema	Default
query_strings required	Method Query Strings Example : `{'param1': 'value1', 'param2': 'value2'}`	object[boolean]
request_headers required	Method Request Headers Example : `{'test1' : True}`	object[boolean]

41 - MethodSetRequestV1Dot1

Name	Description	Schema
api_key_required required	Api Key Required Example : `False`	boolean
endpoint_url optional	Method Endpoint URL Example : `https://127.0.0.1:8000`	any of [string, null]
function_id optional	Cloud Function ID Example : `27bb070b564349f8a31cc60734cc36a5`	any of [string, null]
integration_type required	Method Integration Type Example : `HTTP`	enum (HTTP, SCF, PRIVATELINK)
privatelink_endpoint_id optional	PrivateLink Endpoint ID Example : `27bb070b564349f8a31cc60734cc36a5`	any of [string, null]
query_strings required	Method Query Strings Example : `{'param1': 'value1', 'param2': 'value2'}`	object[boolean]
request_headers required	Method Request Headers Example : `{'test1' : True}`	object[boolean]

42 - MethodShowResponse

Name	Description	Schema	Default
method required		Method

43 - MethodShowResponseV1Dot1

Name	Description	Schema	Default
method required		MethodV1Dot1

44 - MethodShowResponseV1Dot2

Name	Description	Schema	Default
method required		MethodV1Dot2

45 - MethodV1Dot1

Name	Description	Schema
api_key_required optional	Api Key Required Example : `False`	boolean
endpoint_url optional	Method Endpoint URL Example : `https://127.0.0.1:8000`	any of [string, null]
function_id optional	Cloud Function ID Example : `27bb070b564349f8a31cc60734cc36a5`	any of [string, null]
function_name optional	Cloud Function Name Example : `test-function`	any of [string, null]
integration_type required	Method Integration Type Example : `HTTP`	string
method_type required	Method Type Example : `GET`	string
query_strings optional	Method Query Strings Example : `{'param1': 'value1', 'param2': 'value2'}`	any of [object[boolean], null]
request_headers optional	Method Request Headers Example : `{'test1' : True}`	any of [object[boolean], null]
request_path optional	Method Request Path Example : `{users}`	any of [array[object], null]
srn required	SRN Example : `srn:dev2::9b7653f6f47a42e38055934a0575a813:kr-west1::apiateway:method/151a6c15922747faaaae7f70/*/GET/test`	string

46 - MethodV1Dot2

Name	Description	Schema
api_key_required optional	Api Key Required Example : `False`	boolean
endpoint_url optional	Method Endpoint URL Example : `https://127.0.0.1:8000`	any of [string, null]
function_id optional	Cloud Function ID Example : `27bb070b564349f8a31cc60734cc36a5`	any of [string, null]
function_name optional	Cloud Function Name Example : `test-function`	any of [string, null]
integration_type required	Method Integration Type Example : `HTTP`	string
method_type required	Method Type Example : `GET`	string
privatelink_endpoint_id optional	PrivateLink Endpoint ID Example : `27bb070b564349f8a31cc60734cc36a5`	any of [string, null]
query_strings optional	Method Query Strings Example : `{'param1': 'value1', 'param2': 'value2'}`	any of [object[boolean], null]
request_headers optional	Method Request Headers Example : `{'test1' : True}`	any of [object[boolean], null]
request_path optional	Method Request Path Example : `{users}`	any of [array[object], null]
srn required	SRN Example : `srn:dev2::9b7653f6f47a42e38055934a0575a813:kr-west1::apiateway:method/151a6c15922747faaaae7f70/*/GET/test`	string

47 - PrivateLinkEndpoint

Name	Description	Schema
created_at required	Creation Date Example : `2024-05-17T00:23:17Z`	string (date-time)
id required	PrivateLink Endpoint ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
name required	PrivateLink Endpoint Name Example : `endpoint`	string
privatelink_service_id required	PrivateLink Service ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
status required	PrivateLink Endpoint Status Example : `CANCELED`	string

48 - PrivateLinkEndpointApprovalRequest

Name	Description	Schema	Default
api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
type required	PrivateLink Endpoint Action Type Example : `CANCEL`	enum (APPROVE, REJECT)

49 - PrivateLinkEndpointConnectionRequest

Name	Description	Schema	Default
api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
type required	PrivateLink Endpoint Action Type Example : `CANCEL`	enum (DISCONNECT, RECONNECT)

50 - PrivateLinkEndpointCreateRequest

Name	Description	Schema
description optional	Description Example : `description`	any of [string, null]
name required	PrivateLink Endpoint Name Example : `endpoint` Pattern : `^[a-zA-Z0-9]$` Minimum length* : `3` Maximum length : `20`	string
privatelink_service_id required	PrivateLink Service ID Example : `27bb070b564349f8a31cc60734cc36a5`	string

51 - PrivateLinkEndpointDetail

Name	Description	Schema
created_at required	Creation Date Example : `2024-05-17T00:23:17Z`	string (date-time)
description optional	Description Example : `description`	string
id required	PrivateLink Endpoint ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
name required	PrivateLink Endpoint Name Example : `endpoint`	string
privatelink_service_id required	PrivateLink Service ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
status required	PrivateLink Endpoint Status Example : `CANCELED`	string

52 - PrivateLinkEndpointListResponse

Name	Description	Schema	Default
count required	Total Count Example : `20`	integer
privatelink_endpoints required		array[PrivateLinkEndpoint]

53 - PrivateLinkEndpointRequestRequest

Name	Description	Schema	Default
type required	PrivateLink Endpoint Action Type Example : `CANCEL`	enum (CANCEL, RE_REQUEST)

54 - PrivateLinkEndpointSetRequest

Name	Description	Schema	Default
description optional	Description Example : `description`	any of [string, null]

55 - PrivateLinkEndpointShowResponse

Name	Description	Schema	Default
privatelink_endpoint required		PrivateLinkEndpointDetail

56 - PrivateLinkEndpointSummary

Name	Description	Schema
created_at required	Creation Date Example : `2024-05-17T00:23:17Z`	string (date-time)
id required	PrivateLink Endpoint ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
status required	PrivateLink Endpoint Status Example : `Active`	string

57 - PrivateLinkEndpointSummaryShowResponse

Name	Description	Schema	Default
privatelink_endpoint required		PrivateLinkEndpointSummary

58 - Report

Name	Description	Schema
call_count required	Call Count Example : `10`	integer
date required	Date Example :	string
error_4xx_count required	Error 4xx Count Example : `10`	integer
error_5xx_count optional	Error 5xx Count Example : `10`	integer
integration_latency required	Integration Latency Example : `10`	object
latency required	Latency Example : `10`	object

59 - ReportListResponse

Name	Description	Schema
count required	Total Count Example : `20`	integer
reports required		array[Report]
top_resources required		array[TopResource]

60 - Resource

Name	Description	Schema
id required	Resource ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
methods required		array[Method]
parent_id required	Parent Resource ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
path required	Path Example : `/test/test1`	string
path_part required	Path Part Example : `test`	string

61 - ResourceCreateRequest

Name	Description	Schema	Default
path_part required	Path Part Example : `test` Pattern : `^(\{[a-z][a-z0-9\-]{1,46}[a-z0-9]\}\|[a-z][a-z0-9\-]{1,48}[a-z0-9])$` Minimum length : `3` Maximum length : `50`	string

62 - ResourceCreateResponse

Name	Description	Schema
api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
id required	Resource ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
parent_id required	Parent Resource ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
path required	Path Example :	string

63 - ResourceListResponse

Name	Description	Schema	Default
resources required		array[Resource]

64 - ResourceListResponseV1Dot1

Name	Description	Schema	Default
resources required		array[ResourceV1Dot1]

65 - ResourceListResponseV1Dot2

Name	Description	Schema	Default
resources required		array[ResourceV1Dot2]

66 - ResourceShowResponse

Name	Description	Schema	Default
resource required		Resource

67 - ResourceShowResponseV1Dot1

Name	Description	Schema	Default
resource required		ResourceV1Dot1

68 - ResourceShowResponseV1Dot2

Name	Description	Schema	Default
resource required		ResourceV1Dot2

69 - ResourceSummary

Name	Description	Schema	Default
methods required	Method Type Example : `GET`	array[string]
path required	Path Example : `/test/test1`	string

70 - ResourceSummaryV1Dot1

Name	Description	Schema	Default
methods required		array[MethodInStage]
path required	Path Example : `/test/test1`	string

71 - ResourceV1Dot1

Name	Description	Schema
id required	Resource ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
methods required		array[MethodV1Dot1]
parent_id required	Parent Resource ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
path required	Path Example : `/test/test1`	string
path_part required	Path Part Example : `test`	string

72 - ResourceV1Dot2

Name	Description	Schema
id required	Resource ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
methods required		array[MethodV1Dot2]
parent_id required	Parent Resource ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
path required	Path Example : `/test/test1`	string
path_part required	Path Part Example : `test`	string

73 - Stage

Name	Description	Schema
active_deployment required	Active Deployment Example : `2024-05-17T00:23:17Z`	string (date-time)
allow_credentials optional	Allow Credentials Example : `True`	any of [boolean, null]
allow_headers optional	Allow Headers Example : `['Content-Type', 'Authorization']`	any of [array[string], null]
allow_methods optional	Allow Methods Example : `['GET', 'POST', 'PUT', 'PATCH']`	any of [array[enum (GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS, ANY)], null]
allow_origins optional	Allow Origins Example : `['*']`	any of [array[string], null]
api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
api_summary required	API Summary Example : `[{'methods': ['GET', 'POST'], 'path': '/'}, {'methods': ['GET', 'POST'], 'path': '/test'}]`	array[ResourceSummary]
cors_enabled required	Cors Enabled Example : `False`	boolean
created_at required	Creation Date Example :	string (date-time)
deployment_id required	Deployment ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
expose_headers optional	Expose Headers Example : `['test1', 'test2']`	any of [array[string], null]
invoke_url required	Invoke URL Example : `http://test.com/stg`	string
ip_restriction_enabled required	IP Restriction Enabled Example : `False`	boolean
jwt_enabled required	JWT Enabled Example : `False`	boolean
max_age optional	Max Age Example : `3600`	any of [integer, null]
name required	Stage Name Example : `test-stage`	string

74 - StageCreateRequest

Name	Description	Schema
deployment_id required	Deployment ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
description optional	Description Example : `description`	any of [string, null]
stage_name required	Name Example : `test-stage` Pattern : `^[a-z][a-z0-9\-]{1,48}[a-z0-9]$` Minimum length : `3` Maximum length : `50`	string

75 - StageDetail

Name	Description	Schema
active_deployment required	Active Deployment Example : `2024-05-17T00:23:17Z`	string (date-time)
allow_credentials optional	Allow Credentials Example : `True`	any of [boolean, null]
allow_headers optional	Allow Headers Example : `['Content-Type', 'Authorization']`	any of [array[string], null]
allow_methods optional	Allow Methods Example : `['GET', 'POST', 'PUT', 'PATCH']`	any of [array[enum (GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS, ANY)], null]
allow_origins optional	Allow Origins Example : `['*']`	any of [array[string], null]
api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
cors_enabled required	Cors Enabled Example : `False`	boolean
created_at required	Creation Date Example :	string (date-time)
deployment_id required	Deployment ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
expose_headers optional	Expose Headers Example : `['test1', 'test2']`	any of [array[string], null]
invoke_url required	Invoke URL Example : `http://test.com/stg`	string
ip_restriction_enabled required	IP Restriction Enabled Example : `False`	boolean
jwt_enabled required	JWT Enabled Example : `False`	boolean
max_age optional	Max Age Example : `3600`	any of [integer, null]
name required	Stage Name Example : `test-stage`	string

76 - StageDetailV1Dot1

Name	Description	Schema
active_deployment required	Active Deployment Example : `2024-05-17T00:23:17Z`	string (date-time)
allow_credentials optional	Allow Credentials Example : `True`	any of [boolean, null]
allow_headers optional	Allow Headers Example : `['Content-Type', 'Authorization']`	any of [array[string], null]
allow_methods optional	Allow Methods Example : `['GET', 'POST', 'PUT', 'PATCH']`	any of [array[enum (GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS, ANY)], null]
allow_origins optional	Allow Origins Example : `['*']`	any of [array[string], null]
api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
api_key_required required	Api Key Required Example : `False`	boolean
cors_enabled required	Cors Enabled Example : `False`	boolean
created_at required	Creation Date Example :	string (date-time)
deployment_id required	Deployment ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
description optional	Description Example : `description`	any of [string, null]
expose_headers optional	Expose Headers Example : `['test1', 'test2']`	any of [array[string], null]
invoke_url required	Invoke URL Example : `http://test.com/stg`	string
jwt_enabled required	JWT Enabled Example : `False`	boolean
max_age optional	Max Age Example : `3600`	any of [integer, null]
name required	Stage Name Example : `test-stage`	string
usage_plan_api_keys optional	API Keys	any of [array[ApiKeyInStage], null]
usage_plan_id optional	Usage Plan ID Example : `27bb070b564349f8a31cc60734cc36a5`	any of [string, null]
usage_plan_limit optional	Usage Plan Limit Example : `10`	any of [integer, null]
usage_plan_name optional	Name Example : `usage-plan-name`	any of [string, null]
usage_plan_rate optional	Usage Plan Rate Example : `day`	any of [enum (hour, day, month), null]

77 - StageListResponse

Name	Description	Schema	Default
stages required		array[Stage]

78 - StageListResponseV1Dot1

Name	Description	Schema	Default
stages required		array[StageV1Dot1]

79 - StageSetActiveDeploymentRequest

Name	Description	Schema	Default
deployment_id required	Deployment ID Example : `27bb070b564349f8a31cc60734cc36a5`	string

80 - StageSetConfigRequest

Name	Description	Schema
allow_credentials optional	Allow Credentials Example : `True`	any of [boolean, null]
allow_headers optional	Allow Headers Example : `['Content-Type', 'Authorization']`	any of [array[string], null]
allow_methods optional	Allow Methods Example : `['GET', 'POST', 'PUT', 'PATCH']`	any of [array[enum (GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS, ANY)], null]
allow_origins optional	Allow Origins Example : `['*']`	any of [array[string], null]
cors_enabled required	Cors Enabled Example : `False`	boolean
expose_headers optional	Expose Headers Example : `['test1', 'test2']`	any of [array[string], null]
ip_restriction_enabled required	IP Restriction Enabled Example : `False`	boolean
jwt_enabled required	JWT Enabled Example : `False`	boolean
max_age optional	Max Age Example : `3600`	any of [integer, null]

81 - StageSetConfigRequestV1Dot1

Name	Description	Schema
allow_credentials optional	Allow Credentials Example : `True`	any of [boolean, null]
allow_headers optional	Allow Headers Example : `['Content-Type', 'Authorization']`	any of [array[string], null]
allow_methods optional	Allow Methods Example : `['GET', 'POST', 'PUT', 'PATCH']`	any of [array[enum (GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS, ANY)], null]
allow_origins optional	Allow Origins Example : `['*']`	any of [array[string], null]
connected_api_keys optional	Connected API Keys Example : `['key1', 'key2']`	any of [array[string], null]
cors_enabled required	Cors Enabled Example : `False`	boolean
description optional	Description Example : `description`	any of [string, null]
expose_headers optional	Expose Headers Example : `['test1', 'test2']`	any of [array[string], null]
jwt_enabled required	JWT Enabled Example : `False`	boolean
max_age optional	Max Age Example : `3600`	any of [integer, null]
usage_plan_id optional	Usage Plan ID Example : `27bb070b564349f8a31cc60734cc36a5`	any of [string, null]

82 - StageShowResponse

Name	Description	Schema	Default
stage required		StageDetail

83 - StageShowResponseV1Dot1

Name	Description	Schema	Default
stage required		StageDetailV1Dot1

84 - StageV1Dot1

Name	Description	Schema
active_deployment required	Active Deployment Example : `2024-05-17T00:23:17Z`	string (date-time)
allow_credentials optional	Allow Credentials Example : `True`	any of [boolean, null]
allow_headers optional	Allow Headers Example : `['Content-Type', 'Authorization']`	any of [array[string], null]
allow_methods optional	Allow Methods Example : `['GET', 'POST', 'PUT', 'PATCH']`	any of [array[enum (GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS, ANY)], null]
allow_origins optional	Allow Origins Example : `['*']`	any of [array[string], null]
api_id required	Api ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
api_key_required required	Api Key Required Example : `False`	boolean
api_summary required	API Summary Example : `[{'methods': [{'api_key_required': True, 'type': 'GET'}, {'api_key_required': False, 'type': 'POST'}], 'path': '/'}, {'methods': [{'api_key_required': True, 'type': 'GET'}, {'api_key_required': False, 'type': 'POST'}], 'path': '/test'}]`	array[ResourceSummaryV1Dot1]
cors_enabled required	Cors Enabled Example : `False`	boolean
created_at required	Creation Date Example :	string (date-time)
deployment_id required	Deployment ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
description optional	Description Example : `description`	any of [string, null]
expose_headers optional	Expose Headers Example : `['test1', 'test2']`	any of [array[string], null]
invoke_url required	Invoke URL Example : `http://test.com/stg`	string
jwt_enabled required	JWT Enabled Example : `False`	boolean
max_age optional	Max Age Example : `3600`	any of [integer, null]
name required	Stage Name Example : `test-stage`	string
usage_plan_api_keys optional	API Keys	any of [array[ApiKeyInStage], null]
usage_plan_id optional	Usage Plan ID Example : `27bb070b564349f8a31cc60734cc36a5`	any of [string, null]
usage_plan_limit optional	Usage Plan Limit Example : `10`	any of [integer, null]
usage_plan_name optional	Name Example : `usage-plan-name`	any of [string, null]
usage_plan_rate optional	Usage Plan Rate Example : `day`	any of [enum (hour, day, month), null]

85 - Tag

Name	Description	Schema	Default
key required	tag key Example : `key`	string
value required	tag value Example : `value`	string

86 - TopResource

Name	Description	Schema
call_count required	Call Count Example : `10`	integer
name required	Resource Name Example : `test`	string
path required	Resource Path Example : `/test/test1`	string
type required	Method Type Example : `GET`	string

87 - UsagePlan

Name	Description	Schema
connected_api_keys required	Connected API Keys Example : `['key1', 'key2']`	array[string]
created_at required	Creation Date Example :	string (date-time)
description optional	Description Example : `description`	string
id required	Usage Plan ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
limit required	Usage Plan Limit Example : `10`	integer
name required	Name Example : `usage-plan-name`	string
rate required	Usage Plan Rate Example : `day`	enum (hour, day, month)

88 - UsagePlanCreateRequest

Name	Description	Schema
description optional	Description Example : `description`	any of [string, null]
limit required	Usage Plan Limit Example : `10` Minimum : `1` Maximum : `2000000000`	integer
name required	Name Example : `usage-plan-name` Pattern : `^[a-z][a-z0-9\-]{1,48}[a-z0-9]$` Minimum length : `3` Maximum length : `50`	string
rate required	Usage Plan Rate Example : `day`	enum (hour, day, month)

89 - UsagePlanDetail

Name	Description	Schema
api_keys required	API Keys	array[ApiKey]
created_at required	Creation Date Example :	string (date-time)
created_by_id required	Created by Example : `27bb070b564349f8a31cc60734cc36a5`	string
created_by_name required	Created by Example : `username`	string
description optional	Description Example : `description`	string
id required	Usage Plan ID Example : `27bb070b564349f8a31cc60734cc36a5`	string
limit required	Usage Plan Limit Example : `10`	integer
modified_at required	Modified at Example :	string (date-time)
modified_by_id required	Modified by Example : `27bb070b564349f8a31cc60734cc36a5`	string
modified_by_name required	Modified by Example : `username`	string
name required	Name Example : `usage-plan-name`	string
rate required	Usage Plan Rate Example : `day`	enum (hour, day, month)

90 - UsagePlanListResponse

Name	Description	Schema	Default
count required	Total Count Example : `20`	integer
usage_plans required		array[UsagePlan]

91 - UsagePlanSetDescriptionRequest

Name	Description	Schema	Default
description optional	Description Example : `description`	any of [string, null]

92 - UsagePlanSetQuotaRequest

Name	Description	Schema	Default
limit required	Usage Plan Limit Example : `10` Minimum : `1` Maximum : `2000000000`	integer
rate required	Usage Plan Rate Example : `day`	enum (hour, day, month)

93 - UsagePlanShowResponse

Name	Description	Schema	Default
usage_plan required		UsagePlanDetail