4 - description: OSM NB API
5 url: 'https://osm.etsi.org/nbapi/v1.0.0'
9 This is Open Source MANO Northbound API featuring ETSI NFV SOL005.
10 For more information on OSM, you can visit [http://osm.etsi.org](http://osm.etsi.org).
11 You can send us your comments and questions to OSM_TECH@list.etsi.org
12 or join the [OpenSourceMANO Slack Workplace](https://join.slack.com/t/opensourcemano/shared_invite/enQtMzQ3MzYzNTQ0NDIyLWVkNTE4ZjZjNWI0ZTQyN2VhOTI1MjViMzU1NWYwMWM3ODI4NTQyY2VlODA2ZjczMWIyYTFkZWNiZmFkM2M2ZDk)
14 title: OSM NB API featuring ETSI NFV SOL005
16 email: OSM_TECH@list.etsi.org
19 url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
22 - name: 'VNF packages'
23 description: Management operations of VNF descriptors and packages
25 description: Management operations of NS descriptors and packages
26 - name: 'NS instances'
27 description: Management operations of NS instances
28 - name: 'NetSlice templates'
29 description: Management operations of NetSlice Templates
30 - name: 'NetSlice instances'
31 description: Management operations of NetSlice Instances
32 - name: 'NS Performance Management'
33 description: Management operations related to Performance Mangement of NS instances
34 - name: 'Physical Data Units (PDU)'
35 description: Management operations of PDUs
36 - name: 'Authentication'
37 description: Authentication operations
39 description: Management operations of users, projects and roles
40 - name: 'Infrastructure'
41 description: Management operations of VIM, VIM accounts, WIM and SDN controllers
42 - name: 'Repositories'
43 description: Management operations of repositories
45 description: Management operations of Administration items
53 '/nsd/v1/ns_descriptors':
57 summary: Query information about multiple NS descriptor resources
58 description: Query information about multiple NS descriptor resources
66 $ref: '#/components/schemas/ArrayOfNsdInfo'
69 $ref: '#/components/schemas/ArrayOfNsdInfo'
71 $ref: '#/components/responses/BadRequest'
73 $ref: '#/components/responses/Unauthorized'
75 $ref: '#/components/responses/Forbidden'
77 $ref: '#/components/responses/NotFound'
79 $ref: '#/components/responses/MethodNotAllowed'
81 $ref: '#/components/responses/NotAcceptable'
83 $ref: '#/components/responses/Conflict'
85 $ref: '#/components/responses/UnprocessableEntity'
87 $ref: '#/components/responses/InternalServerError'
89 $ref: '#/components/responses/ServiceUnavailable'
91 $ref: '#/components/responses/UnexpectedError'
93 $ref: '#/components/responses/UnexpectedError'
97 summary: Create a new NS descriptor resource
98 description: Create a new NS descriptor resource
101 $ref: '#/components/requestBodies/CreateNsdInfoRequest'
113 $ref: '#/components/schemas/ObjectId'
116 $ref: '#/components/schemas/ObjectId'
118 $ref: '#/components/responses/BadRequest'
120 $ref: '#/components/responses/Unauthorized'
122 $ref: '#/components/responses/Forbidden'
124 $ref: '#/components/responses/NotFound'
126 $ref: '#/components/responses/MethodNotAllowed'
128 $ref: '#/components/responses/NotAcceptable'
130 $ref: '#/components/responses/Conflict'
132 $ref: '#/components/responses/UnprocessableEntity'
134 $ref: '#/components/responses/InternalServerError'
136 $ref: '#/components/responses/ServiceUnavailable'
138 $ref: '#/components/responses/UnexpectedError'
140 $ref: '#/components/responses/UnexpectedError'
141 '/nsd/v1/ns_descriptors/{nsdInfoId}':
146 description: NSD Info ID
152 summary: Read information about an individual NS descriptor resource
153 description: Read information about an individual NS descriptor resource
161 $ref: '#/components/schemas/NsdInfo'
164 $ref: '#/components/schemas/NsdInfo'
166 $ref: '#/components/responses/BadRequest'
168 $ref: '#/components/responses/Unauthorized'
170 $ref: '#/components/responses/Forbidden'
172 $ref: '#/components/responses/NotFound'
174 $ref: '#/components/responses/MethodNotAllowed'
176 $ref: '#/components/responses/NotAcceptable'
178 $ref: '#/components/responses/Conflict'
180 $ref: '#/components/responses/UnprocessableEntity'
182 $ref: '#/components/responses/InternalServerError'
184 $ref: '#/components/responses/ServiceUnavailable'
186 $ref: '#/components/responses/UnexpectedError'
188 $ref: '#/components/responses/UnexpectedError'
192 summary: Delete an individual NS descriptor resource
193 description: Delete an individual NS descriptor resource
194 operationId: deleteNSD
197 description: No Content
199 $ref: '#/components/responses/BadRequest'
201 $ref: '#/components/responses/Unauthorized'
203 $ref: '#/components/responses/Forbidden'
205 $ref: '#/components/responses/NotFound'
207 $ref: '#/components/responses/MethodNotAllowed'
209 $ref: '#/components/responses/NotAcceptable'
211 $ref: '#/components/responses/Conflict'
213 $ref: '#/components/responses/UnprocessableEntity'
215 $ref: '#/components/responses/InternalServerError'
217 $ref: '#/components/responses/ServiceUnavailable'
219 $ref: '#/components/responses/UnexpectedError'
221 $ref: '#/components/responses/UnexpectedError'
225 summary: Modify the data of an individual NS descriptor resource
226 description: Modify the data of an individual NS descriptor resource
227 operationId: updateNSD
229 $ref: '#/components/requestBodies/NsdInfoModifications'
232 description: No Content
234 $ref: '#/components/responses/BadRequest'
236 $ref: '#/components/responses/Unauthorized'
238 $ref: '#/components/responses/Forbidden'
240 $ref: '#/components/responses/NotFound'
242 $ref: '#/components/responses/MethodNotAllowed'
244 $ref: '#/components/responses/NotAcceptable'
246 $ref: '#/components/responses/Conflict'
248 $ref: '#/components/responses/UnprocessableEntity'
250 $ref: '#/components/responses/InternalServerError'
252 $ref: '#/components/responses/ServiceUnavailable'
254 $ref: '#/components/responses/UnexpectedError'
256 $ref: '#/components/responses/UnexpectedError'
257 '/nsd/v1/ns_descriptors/{nsdInfoId}/nsd_content':
262 description: NSD Info ID
268 summary: Fetch the content of a NSD
269 description: Fetch the content of a NSD
270 operationId: getNSDcontent
277 $ref: '#/components/schemas/NsPackage'
279 description: Partial Content
287 $ref: '#/components/schemas/NsPackage'
289 $ref: '#/components/responses/BadRequest'
291 $ref: '#/components/responses/Unauthorized'
293 $ref: '#/components/responses/Forbidden'
295 $ref: '#/components/responses/NotFound'
297 $ref: '#/components/responses/MethodNotAllowed'
299 $ref: '#/components/responses/NotAcceptable'
301 $ref: '#/components/responses/Conflict'
303 $ref: '#/components/responses/UnprocessableEntity'
305 $ref: '#/components/responses/InternalServerError'
307 $ref: '#/components/responses/ServiceUnavailable'
309 $ref: '#/components/responses/UnexpectedError'
311 $ref: '#/components/responses/UnexpectedError'
315 summary: Upload the content of a NSD
316 description: Upload the content of a NSD
317 operationId: updateNSDcontent
319 $ref: '#/components/requestBodies/NsPackage'
322 description: Accepted
324 description: No Content
326 $ref: '#/components/responses/BadRequest'
328 $ref: '#/components/responses/Unauthorized'
330 $ref: '#/components/responses/Forbidden'
332 $ref: '#/components/responses/NotFound'
334 $ref: '#/components/responses/MethodNotAllowed'
336 $ref: '#/components/responses/NotAcceptable'
338 $ref: '#/components/responses/Conflict'
340 $ref: '#/components/responses/UnprocessableEntity'
342 $ref: '#/components/responses/InternalServerError'
344 $ref: '#/components/responses/ServiceUnavailable'
346 $ref: '#/components/responses/UnexpectedError'
348 $ref: '#/components/responses/UnexpectedError'
349 '/nsd/v1/ns_descriptors/{nsdInfoId}/artifacts/{artifactPath}':
354 description: NS Package ID
360 description: Artifact Path
366 summary: Fetch individual NS package artifact
367 description: Fetch individual NS package artifact
368 operationId: getNsPkgArtifact
373 application/octet-stream:
378 description: Partial Content
384 application/octet-stream:
389 $ref: '#/components/responses/BadRequest'
391 $ref: '#/components/responses/Unauthorized'
393 $ref: '#/components/responses/Forbidden'
395 $ref: '#/components/responses/NotFound'
397 $ref: '#/components/responses/MethodNotAllowed'
399 $ref: '#/components/responses/NotAcceptable'
401 $ref: '#/components/responses/Conflict'
403 $ref: '#/components/responses/UnprocessableEntity'
405 $ref: '#/components/responses/InternalServerError'
407 $ref: '#/components/responses/ServiceUnavailable'
409 $ref: '#/components/responses/UnexpectedError'
411 $ref: '#/components/responses/UnexpectedError'
412 '/nsd/v1/ns_descriptors/{nsdInfoId}/nsd':
417 description: NS Package ID
423 summary: Read NSD of an on-boarded NS package
424 description: Read NSD of an on-boarded NS package
425 operationId: getNsPkgNsd
432 $ref: '#/components/schemas/NsDescriptor'
434 $ref: '#/components/responses/BadRequest'
436 $ref: '#/components/responses/Unauthorized'
438 $ref: '#/components/responses/Forbidden'
440 $ref: '#/components/responses/NotFound'
442 $ref: '#/components/responses/MethodNotAllowed'
444 $ref: '#/components/responses/NotAcceptable'
446 $ref: '#/components/responses/Conflict'
448 $ref: '#/components/responses/UnprocessableEntity'
450 $ref: '#/components/responses/InternalServerError'
452 $ref: '#/components/responses/ServiceUnavailable'
454 $ref: '#/components/responses/UnexpectedError'
456 $ref: '#/components/responses/UnexpectedError'
457 '/nsd/v1/ns_descriptors_content':
461 summary: Upload a NS package by providing the content of the NS package
462 description: Upload a NS package by providing the content of the NS package
463 operationId: uploadNsPkgsContent
468 $ref: '#/components/schemas/NsPackage'
480 $ref: '#/components/schemas/ObjectId'
483 $ref: '#/components/schemas/ObjectId'
485 description: Accepted
487 description: No Content
489 $ref: '#/components/responses/BadRequest'
491 $ref: '#/components/responses/Unauthorized'
493 $ref: '#/components/responses/Forbidden'
495 $ref: '#/components/responses/NotFound'
497 $ref: '#/components/responses/MethodNotAllowed'
499 $ref: '#/components/responses/NotAcceptable'
501 $ref: '#/components/responses/Conflict'
503 $ref: '#/components/responses/UnprocessableEntity'
505 $ref: '#/components/responses/InternalServerError'
507 $ref: '#/components/responses/ServiceUnavailable'
509 $ref: '#/components/responses/UnexpectedError'
511 $ref: '#/components/responses/UnexpectedError'
515 summary: Query information about multiple NS package resources
516 description: Query information about multiple NS package resources
517 operationId: getNsPkgsContent
524 $ref: '#/components/schemas/ArrayOfNsdInfo'
527 $ref: '#/components/schemas/ArrayOfNsdInfo'
529 description: Partial Content
535 application/octet-stream:
540 $ref: '#/components/responses/BadRequest'
542 $ref: '#/components/responses/Unauthorized'
544 $ref: '#/components/responses/Forbidden'
546 $ref: '#/components/responses/NotFound'
548 $ref: '#/components/responses/MethodNotAllowed'
550 $ref: '#/components/responses/NotAcceptable'
552 $ref: '#/components/responses/Conflict'
554 $ref: '#/components/responses/UnprocessableEntity'
556 $ref: '#/components/responses/InternalServerError'
558 $ref: '#/components/responses/ServiceUnavailable'
560 $ref: '#/components/responses/UnexpectedError'
562 $ref: '#/components/responses/UnexpectedError'
563 '/nsd/v1/ns_descriptors_content/{nsdInfoId}':
568 description: NS Package ID
574 summary: Read information about an individual NS package resource
575 description: Read information about an individual NS package resource
576 operationId: getNsPkgsIdContent
583 $ref: '#/components/schemas/NsdInfo'
586 $ref: '#/components/schemas/NsdInfo'
588 $ref: '#/components/responses/BadRequest'
590 $ref: '#/components/responses/Unauthorized'
592 $ref: '#/components/responses/Forbidden'
594 $ref: '#/components/responses/NotFound'
596 $ref: '#/components/responses/MethodNotAllowed'
598 $ref: '#/components/responses/NotAcceptable'
600 $ref: '#/components/responses/Conflict'
602 $ref: '#/components/responses/UnprocessableEntity'
604 $ref: '#/components/responses/InternalServerError'
606 $ref: '#/components/responses/ServiceUnavailable'
608 $ref: '#/components/responses/UnexpectedError'
610 $ref: '#/components/responses/UnexpectedError'
614 summary: Modify an individual NS package resource
615 description: Modify an individual NS package resource
616 operationId: updateNsPkgsIdContent
618 $ref: '#/components/requestBodies/NsdInfoModifications'
621 description: No Content
623 $ref: '#/components/responses/BadRequest'
625 $ref: '#/components/responses/Unauthorized'
627 $ref: '#/components/responses/Forbidden'
629 $ref: '#/components/responses/NotFound'
631 $ref: '#/components/responses/MethodNotAllowed'
633 $ref: '#/components/responses/NotAcceptable'
635 $ref: '#/components/responses/Conflict'
637 $ref: '#/components/responses/UnprocessableEntity'
639 $ref: '#/components/responses/InternalServerError'
641 $ref: '#/components/responses/ServiceUnavailable'
643 $ref: '#/components/responses/UnexpectedError'
645 $ref: '#/components/responses/UnexpectedError'
649 summary: Delete an individual NS package resource
650 description: Delete an individual NS package resource
651 operationId: deleteNSPkgsIdContent
654 description: No Content
656 $ref: '#/components/responses/BadRequest'
658 $ref: '#/components/responses/Unauthorized'
660 $ref: '#/components/responses/Forbidden'
662 $ref: '#/components/responses/NotFound'
664 $ref: '#/components/responses/MethodNotAllowed'
666 $ref: '#/components/responses/NotAcceptable'
668 $ref: '#/components/responses/Conflict'
670 $ref: '#/components/responses/UnprocessableEntity'
672 $ref: '#/components/responses/InternalServerError'
674 $ref: '#/components/responses/ServiceUnavailable'
676 $ref: '#/components/responses/UnexpectedError'
678 $ref: '#/components/responses/UnexpectedError'
682 '/vnfpkgm/v1/vnf_packages':
686 summary: Query information about multiple VNF package resources
687 description: Query information about multiple VNF package resources
688 operationId: getVnfPkgs
695 $ref: '#/components/schemas/ArrayOfVnfPkgInfo'
698 $ref: '#/components/schemas/ArrayOfVnfPkgInfo'
700 $ref: '#/components/responses/BadRequest'
702 $ref: '#/components/responses/Unauthorized'
704 $ref: '#/components/responses/Forbidden'
706 $ref: '#/components/responses/NotFound'
708 $ref: '#/components/responses/MethodNotAllowed'
710 $ref: '#/components/responses/NotAcceptable'
712 $ref: '#/components/responses/Conflict'
714 $ref: '#/components/responses/UnprocessableEntity'
716 $ref: '#/components/responses/InternalServerError'
718 $ref: '#/components/responses/ServiceUnavailable'
720 $ref: '#/components/responses/UnexpectedError'
722 $ref: '#/components/responses/UnexpectedError'
726 summary: Create a new VNF package resource
727 description: Create a new VNF package resource
728 operationId: addVnfPkg
730 $ref: '#/components/requestBodies/CreateVnfPkgInfoRequest'
742 $ref: '#/components/schemas/ObjectId'
745 $ref: '#/components/schemas/ObjectId'
747 $ref: '#/components/responses/BadRequest'
749 $ref: '#/components/responses/Unauthorized'
751 $ref: '#/components/responses/Forbidden'
753 $ref: '#/components/responses/NotFound'
755 $ref: '#/components/responses/MethodNotAllowed'
757 $ref: '#/components/responses/NotAcceptable'
759 $ref: '#/components/responses/Conflict'
761 $ref: '#/components/responses/UnprocessableEntity'
763 $ref: '#/components/responses/InternalServerError'
765 $ref: '#/components/responses/ServiceUnavailable'
767 $ref: '#/components/responses/UnexpectedError'
769 $ref: '#/components/responses/UnexpectedError'
770 '/vnfpkgm/v1/vnf_packages/{vnfPkgId}':
775 description: VNF Package ID
781 summary: Read information about an individual VNF package resource
782 description: Read information about an individual VNF package resource
783 operationId: getVnfPkg
790 $ref: '#/components/schemas/VnfPkgInfo'
793 $ref: '#/components/schemas/VnfPkgInfo'
795 $ref: '#/components/responses/BadRequest'
797 $ref: '#/components/responses/Unauthorized'
799 $ref: '#/components/responses/Forbidden'
801 $ref: '#/components/responses/NotFound'
803 $ref: '#/components/responses/MethodNotAllowed'
805 $ref: '#/components/responses/NotAcceptable'
807 $ref: '#/components/responses/Conflict'
809 $ref: '#/components/responses/UnprocessableEntity'
811 $ref: '#/components/responses/InternalServerError'
813 $ref: '#/components/responses/ServiceUnavailable'
815 $ref: '#/components/responses/UnexpectedError'
817 $ref: '#/components/responses/UnexpectedError'
821 summary: Delete an individual VNF package resource
822 description: Delete an individual VNF package resource
823 operationId: deleteVnfPkg
826 description: No Content
828 $ref: '#/components/responses/BadRequest'
830 $ref: '#/components/responses/Unauthorized'
832 $ref: '#/components/responses/Forbidden'
834 $ref: '#/components/responses/NotFound'
836 $ref: '#/components/responses/MethodNotAllowed'
838 $ref: '#/components/responses/NotAcceptable'
840 $ref: '#/components/responses/Conflict'
842 $ref: '#/components/responses/UnprocessableEntity'
844 $ref: '#/components/responses/InternalServerError'
846 $ref: '#/components/responses/ServiceUnavailable'
848 $ref: '#/components/responses/UnexpectedError'
850 $ref: '#/components/responses/UnexpectedError'
854 summary: Modify an individual VNF package resource
855 description: Modify an individual VNF package resource
856 operationId: updateVnfPkg
858 $ref: '#/components/requestBodies/VnfPkgInfoModifications'
861 description: No Content
863 $ref: '#/components/responses/BadRequest'
865 $ref: '#/components/responses/Unauthorized'
867 $ref: '#/components/responses/Forbidden'
869 $ref: '#/components/responses/NotFound'
871 $ref: '#/components/responses/MethodNotAllowed'
873 $ref: '#/components/responses/NotAcceptable'
875 $ref: '#/components/responses/Conflict'
877 $ref: '#/components/responses/UnprocessableEntity'
879 $ref: '#/components/responses/InternalServerError'
881 $ref: '#/components/responses/ServiceUnavailable'
883 $ref: '#/components/responses/UnexpectedError'
885 $ref: '#/components/responses/UnexpectedError'
886 '/vnfpkgm/v1/vnf_packages/{vnfPkgId}/vnfd':
891 description: VNF Package ID
897 summary: Read VNFD of an on-boarded VNF package
898 description: Read VNFD of an on-boarded VNF package
899 operationId: getVnfPkgVnfd
906 $ref: '#/components/schemas/VnfDescriptor'
908 $ref: '#/components/responses/BadRequest'
910 $ref: '#/components/responses/Unauthorized'
912 $ref: '#/components/responses/Forbidden'
914 $ref: '#/components/responses/NotFound'
916 $ref: '#/components/responses/MethodNotAllowed'
918 $ref: '#/components/responses/NotAcceptable'
920 $ref: '#/components/responses/Conflict'
922 $ref: '#/components/responses/UnprocessableEntity'
924 $ref: '#/components/responses/InternalServerError'
926 $ref: '#/components/responses/ServiceUnavailable'
928 $ref: '#/components/responses/UnexpectedError'
930 $ref: '#/components/responses/UnexpectedError'
931 '/vnfpkgm/v1/vnf_packages/{vnfPkgId}/package_content':
936 description: VNF Package ID
942 summary: Fetch an on-boarded VNF package
943 description: Fetch an on-boarded VNF package
944 operationId: getVnfPkgContent
951 $ref: '#/components/schemas/VnfPackage'
953 description: Partial Content
961 $ref: '#/components/schemas/VnfPackage'
963 $ref: '#/components/responses/BadRequest'
965 $ref: '#/components/responses/Unauthorized'
967 $ref: '#/components/responses/Forbidden'
969 $ref: '#/components/responses/NotFound'
971 $ref: '#/components/responses/MethodNotAllowed'
973 $ref: '#/components/responses/NotAcceptable'
975 $ref: '#/components/responses/Conflict'
977 $ref: '#/components/responses/UnprocessableEntity'
979 $ref: '#/components/responses/InternalServerError'
981 $ref: '#/components/responses/ServiceUnavailable'
983 $ref: '#/components/responses/UnexpectedError'
985 $ref: '#/components/responses/UnexpectedError'
989 summary: Upload a VNF package by providing the content of the VNF package
990 description: Upload a VNF package by providing the content of the VNF package
991 operationId: uploadVnfPkgContent
996 $ref: '#/components/schemas/VnfPackage'
999 description: Accepted
1001 description: No Content
1003 $ref: '#/components/responses/BadRequest'
1005 $ref: '#/components/responses/Unauthorized'
1007 $ref: '#/components/responses/Forbidden'
1009 $ref: '#/components/responses/NotFound'
1011 $ref: '#/components/responses/MethodNotAllowed'
1013 $ref: '#/components/responses/NotAcceptable'
1015 $ref: '#/components/responses/Conflict'
1017 $ref: '#/components/responses/UnprocessableEntity'
1019 $ref: '#/components/responses/InternalServerError'
1021 $ref: '#/components/responses/ServiceUnavailable'
1023 $ref: '#/components/responses/UnexpectedError'
1025 $ref: '#/components/responses/UnexpectedError'
1026 '/vnfpkgm/v1/vnf_packages/{vnfPkgId}/artifacts/{artifactPath}':
1031 description: VNF Package ID
1034 - name: artifactPath
1037 description: Artifact Path
1043 summary: Fetch individual VNF package artifact
1044 description: Fetch individual VNF package artifact
1045 operationId: getVnfPkgArtifact
1050 application/octet-stream:
1055 description: Partial Content
1061 application/octet-stream:
1066 $ref: '#/components/responses/BadRequest'
1068 $ref: '#/components/responses/Unauthorized'
1070 $ref: '#/components/responses/Forbidden'
1072 $ref: '#/components/responses/NotFound'
1074 $ref: '#/components/responses/MethodNotAllowed'
1076 $ref: '#/components/responses/NotAcceptable'
1078 $ref: '#/components/responses/Conflict'
1080 $ref: '#/components/responses/UnprocessableEntity'
1082 $ref: '#/components/responses/InternalServerError'
1084 $ref: '#/components/responses/ServiceUnavailable'
1086 $ref: '#/components/responses/UnexpectedError'
1088 $ref: '#/components/responses/UnexpectedError'
1089 '/vnfpkgm/v1/vnf_packages_content':
1093 summary: Upload a VNF package by providing the content of the VNF package
1094 description: Upload a VNF package by providing the content of the VNF package
1095 operationId: uploadVnfPkgsContent
1100 $ref: '#/components/schemas/VnfPackage'
1103 description: Created
1112 $ref: '#/components/schemas/ObjectId'
1115 $ref: '#/components/schemas/ObjectId'
1117 description: Accepted
1119 description: No Content
1121 $ref: '#/components/responses/BadRequest'
1123 $ref: '#/components/responses/Unauthorized'
1125 $ref: '#/components/responses/Forbidden'
1127 $ref: '#/components/responses/NotFound'
1129 $ref: '#/components/responses/MethodNotAllowed'
1131 $ref: '#/components/responses/NotAcceptable'
1133 $ref: '#/components/responses/Conflict'
1135 $ref: '#/components/responses/UnprocessableEntity'
1137 $ref: '#/components/responses/InternalServerError'
1139 $ref: '#/components/responses/ServiceUnavailable'
1141 $ref: '#/components/responses/UnexpectedError'
1143 $ref: '#/components/responses/UnexpectedError'
1147 summary: Query information about multiple VNF package resources
1148 description: Query information about multiple VNF package resources
1149 operationId: getVnfPkgsContent
1156 $ref: '#/components/schemas/ArrayOfVnfPkgInfo'
1159 $ref: '#/components/schemas/ArrayOfVnfPkgInfo'
1161 description: Partial Content
1167 application/octet-stream:
1172 $ref: '#/components/responses/BadRequest'
1174 $ref: '#/components/responses/Unauthorized'
1176 $ref: '#/components/responses/Forbidden'
1178 $ref: '#/components/responses/NotFound'
1180 $ref: '#/components/responses/MethodNotAllowed'
1182 $ref: '#/components/responses/NotAcceptable'
1184 $ref: '#/components/responses/Conflict'
1186 $ref: '#/components/responses/UnprocessableEntity'
1188 $ref: '#/components/responses/InternalServerError'
1190 $ref: '#/components/responses/ServiceUnavailable'
1192 $ref: '#/components/responses/UnexpectedError'
1194 $ref: '#/components/responses/UnexpectedError'
1195 '/vnfpkgm/v1/vnf_packages_content/{packageContentId}':
1197 - name: packageContentId
1200 description: VNF Package Content ID
1206 summary: Read information about an individual VNF package resource
1207 description: Read information about an individual VNF package resource
1208 operationId: getVnfPkgsIdContent
1215 $ref: '#/components/schemas/VnfPkgInfo'
1218 $ref: '#/components/schemas/VnfPkgInfo'
1220 $ref: '#/components/responses/BadRequest'
1222 $ref: '#/components/responses/Unauthorized'
1224 $ref: '#/components/responses/Forbidden'
1226 $ref: '#/components/responses/NotFound'
1228 $ref: '#/components/responses/MethodNotAllowed'
1230 $ref: '#/components/responses/NotAcceptable'
1232 $ref: '#/components/responses/Conflict'
1234 $ref: '#/components/responses/UnprocessableEntity'
1236 $ref: '#/components/responses/InternalServerError'
1238 $ref: '#/components/responses/ServiceUnavailable'
1240 $ref: '#/components/responses/UnexpectedError'
1242 $ref: '#/components/responses/UnexpectedError'
1246 summary: Modify an individual VNF package resource
1247 description: Modify an individual VNF package resource
1248 operationId: updateVnfPkgsIdContent
1250 $ref: '#/components/requestBodies/VnfPkgInfoModifications'
1253 description: No Content
1255 $ref: '#/components/responses/BadRequest'
1257 $ref: '#/components/responses/Unauthorized'
1259 $ref: '#/components/responses/Forbidden'
1261 $ref: '#/components/responses/NotFound'
1263 $ref: '#/components/responses/MethodNotAllowed'
1265 $ref: '#/components/responses/NotAcceptable'
1267 $ref: '#/components/responses/Conflict'
1269 $ref: '#/components/responses/UnprocessableEntity'
1271 $ref: '#/components/responses/InternalServerError'
1273 $ref: '#/components/responses/ServiceUnavailable'
1275 $ref: '#/components/responses/UnexpectedError'
1277 $ref: '#/components/responses/UnexpectedError'
1281 summary: Delete an individual VNF package resource
1282 description: Delete an individual VNF package resource
1283 operationId: deleteVnfPkgsIdContent
1286 description: No Content
1288 $ref: '#/components/responses/BadRequest'
1290 $ref: '#/components/responses/Unauthorized'
1292 $ref: '#/components/responses/Forbidden'
1294 $ref: '#/components/responses/NotFound'
1296 $ref: '#/components/responses/MethodNotAllowed'
1298 $ref: '#/components/responses/NotAcceptable'
1300 $ref: '#/components/responses/Conflict'
1302 $ref: '#/components/responses/UnprocessableEntity'
1304 $ref: '#/components/responses/InternalServerError'
1306 $ref: '#/components/responses/ServiceUnavailable'
1308 $ref: '#/components/responses/UnexpectedError'
1310 $ref: '#/components/responses/UnexpectedError'
1313 # BEGIN NS Instances
1314 '/nslcm/v1/ns_instances':
1318 summary: Query information about multiple NS instances
1319 description: Query information about multiple NS isntances
1320 operationId: getNSinstances
1327 $ref: '#/components/schemas/ArrayOfNsInstance'
1330 $ref: '#/components/schemas/ArrayOfNsInstance'
1332 $ref: '#/components/responses/BadRequest'
1334 $ref: '#/components/responses/Unauthorized'
1336 $ref: '#/components/responses/Forbidden'
1338 $ref: '#/components/responses/NotFound'
1340 $ref: '#/components/responses/MethodNotAllowed'
1342 $ref: '#/components/responses/NotAcceptable'
1344 $ref: '#/components/responses/Conflict'
1346 $ref: '#/components/responses/UnprocessableEntity'
1348 $ref: '#/components/responses/InternalServerError'
1350 $ref: '#/components/responses/ServiceUnavailable'
1352 $ref: '#/components/responses/UnexpectedError'
1354 $ref: '#/components/responses/UnexpectedError'
1358 summary: Create a new NS instance resource
1359 description: Create a new NS instance resource
1360 operationId: addNSinstance
1362 $ref: '#/components/requestBodies/InstantiateNsRequest'
1365 description: Created
1374 $ref: '#/components/schemas/ObjectId'
1377 $ref: '#/components/schemas/ObjectId'
1379 $ref: '#/components/responses/BadRequest'
1381 $ref: '#/components/responses/Unauthorized'
1383 $ref: '#/components/responses/Forbidden'
1385 $ref: '#/components/responses/NotFound'
1387 $ref: '#/components/responses/MethodNotAllowed'
1389 $ref: '#/components/responses/NotAcceptable'
1391 $ref: '#/components/responses/Conflict'
1393 $ref: '#/components/responses/UnprocessableEntity'
1395 $ref: '#/components/responses/InternalServerError'
1397 $ref: '#/components/responses/ServiceUnavailable'
1399 $ref: '#/components/responses/UnexpectedError'
1401 $ref: '#/components/responses/UnexpectedError'
1402 '/nslcm/v1/ns_instances/{nsInstanceId}':
1404 - name: nsInstanceId
1407 description: NS Instance ID
1410 - name: vcaStatusRefresh
1413 description: Set to true if vca status needs to be refreshed.
1419 summary: Read an individual NS instance resource
1420 description: Read an individual NS instance resource
1421 operationId: getNSinstance
1428 $ref: '#/components/schemas/NsInstance'
1431 $ref: '#/components/schemas/NsInstance'
1433 $ref: '#/components/responses/BadRequest'
1435 $ref: '#/components/responses/Unauthorized'
1437 $ref: '#/components/responses/Forbidden'
1439 $ref: '#/components/responses/NotFound'
1441 $ref: '#/components/responses/MethodNotAllowed'
1443 $ref: '#/components/responses/NotAcceptable'
1445 $ref: '#/components/responses/Conflict'
1447 $ref: '#/components/responses/UnprocessableEntity'
1449 $ref: '#/components/responses/InternalServerError'
1451 $ref: '#/components/responses/ServiceUnavailable'
1453 $ref: '#/components/responses/UnexpectedError'
1455 $ref: '#/components/responses/UnexpectedError'
1459 summary: Delete an individual NS instance resource
1460 description: Delete an individual NS instance resource
1461 operationId: deleteNSinstance
1464 description: No Content
1466 $ref: '#/components/responses/BadRequest'
1468 $ref: '#/components/responses/Unauthorized'
1470 $ref: '#/components/responses/Forbidden'
1472 $ref: '#/components/responses/NotFound'
1474 $ref: '#/components/responses/MethodNotAllowed'
1476 $ref: '#/components/responses/NotAcceptable'
1478 $ref: '#/components/responses/Conflict'
1480 $ref: '#/components/responses/UnprocessableEntity'
1482 $ref: '#/components/responses/InternalServerError'
1484 $ref: '#/components/responses/ServiceUnavailable'
1486 $ref: '#/components/responses/UnexpectedError'
1488 $ref: '#/components/responses/UnexpectedError'
1489 '/nslcm/v1/ns_instances/{nsInstanceId}/instantiate':
1491 - name: nsInstanceId
1494 description: NS Instance ID
1500 summary: Instantiate a NS
1502 Instantiate a NS. The precondition is that the NS instance must have
1503 been created and must be in NOT_INSTANTIATED state. As a result of the
1504 success of this operation, the NFVO creates a "NS Lifecycle Operation
1505 Occurrence" resource for the request, and the NS instance state becomes
1507 operationId: instantiateNSinstance
1509 $ref: '#/components/requestBodies/InstantiateNsRequest'
1512 description: Accepted
1516 It must point to the new "NS Lifecycle Operation Occurrence"
1517 resource, i.e. an URI like ".../ns_lcm_op_occs/{nsLcmOpOccId}"
1524 $ref: '#/components/schemas/ObjectId'
1527 $ref: '#/components/schemas/ObjectId'
1529 $ref: '#/components/responses/BadRequest'
1531 $ref: '#/components/responses/Unauthorized'
1533 $ref: '#/components/responses/Forbidden'
1535 $ref: '#/components/responses/NotFound'
1537 $ref: '#/components/responses/MethodNotAllowed'
1539 $ref: '#/components/responses/NotAcceptable'
1541 $ref: '#/components/responses/Conflict'
1543 $ref: '#/components/responses/UnprocessableEntity'
1545 $ref: '#/components/responses/InternalServerError'
1547 $ref: '#/components/responses/ServiceUnavailable'
1549 $ref: '#/components/responses/UnexpectedError'
1551 $ref: '#/components/responses/UnexpectedError'
1552 '/nslcm/v1/ns_instances/{nsInstanceId}/scale':
1554 - name: nsInstanceId
1557 description: NS Instance ID
1563 summary: Scale a NS instance
1565 Scale a NS instance. The precondition is that the NS instance must have
1566 been created and must be in INSTANTIATED state. As a result of the
1567 success of this operation, the NFVO creates a "NS Lifecycle Operation
1568 Occurrence" resource for the request, and the NS instance state remains
1570 operationId: scaleNSinstance
1572 $ref: '#/components/requestBodies/ScaleNsRequest'
1575 description: Accepted
1579 It must point to the new "NS Lifecycle Operation Occurrence"
1580 resource, i.e. an URI like ".../ns_lcm_op_occs/{nsLcmOpOccId}"
1585 $ref: '#/components/responses/BadRequest'
1587 $ref: '#/components/responses/Unauthorized'
1589 $ref: '#/components/responses/Forbidden'
1591 $ref: '#/components/responses/NotFound'
1593 $ref: '#/components/responses/MethodNotAllowed'
1595 $ref: '#/components/responses/NotAcceptable'
1597 $ref: '#/components/responses/Conflict'
1599 $ref: '#/components/responses/UnprocessableEntity'
1601 $ref: '#/components/responses/InternalServerError'
1603 $ref: '#/components/responses/ServiceUnavailable'
1605 $ref: '#/components/responses/UnexpectedError'
1607 $ref: '#/components/responses/UnexpectedError'
1608 '/nslcm/v1/ns_instances/{nsInstanceId}/heal':
1610 - name: nsInstanceId
1613 description: NS Instance ID
1619 summary: Heal a NS instance
1621 Heal a NS instance. The precondition is that the NS instance must have
1622 been created and must be in INSTANTIATED state. As a result of the
1623 success of this operation, the NFVO creates a "NS Lifecycle Operation
1624 Occurrence" resource for the request, and the NS instance state remains
1626 operationId: healNSinstance
1628 $ref: '#/components/requestBodies/HealNsRequest'
1631 description: Accepted
1635 It must point to the new "NS Lifecycle Operation Occurrence"
1636 resource, i.e. an URI like ".../ns_lcm_op_occs/{nsLcmOpOccId}"
1641 $ref: '#/components/responses/BadRequest'
1643 $ref: '#/components/responses/Unauthorized'
1645 $ref: '#/components/responses/Forbidden'
1647 $ref: '#/components/responses/NotFound'
1649 $ref: '#/components/responses/MethodNotAllowed'
1651 $ref: '#/components/responses/NotAcceptable'
1653 $ref: '#/components/responses/Conflict'
1655 $ref: '#/components/responses/UnprocessableEntity'
1657 $ref: '#/components/responses/InternalServerError'
1659 $ref: '#/components/responses/ServiceUnavailable'
1661 $ref: '#/components/responses/UnexpectedError'
1663 $ref: '#/components/responses/UnexpectedError'
1664 '/nslcm/v1/ns_instances/{nsInstanceId}/terminate':
1666 - name: nsInstanceId
1669 description: NS Instance ID
1675 summary: Terminate a NS instance
1677 Terminate a NS instance. The precondition is that the NS instance must have
1678 been created and must be in INSTANTIATED state. As a result of the
1679 success of this operation, the NFVO creates a "NS Lifecycle Operation
1680 Occurrence" resource for the request, and the NS instance state becomes
1682 operationId: terminateNSinstance
1684 # Request data is not required
1685 $ref: '#/components/requestBodies/TerminateNsRequest'
1688 description: Accepted
1692 It must point to the new "NS Lifecycle Operation Occurrence"
1693 resource, i.e. an URI like ".../ns_lcm_op_occs/{nsLcmOpOccId}"
1700 $ref: '#/components/schemas/ObjectId'
1703 $ref: '#/components/schemas/ObjectId'
1705 $ref: '#/components/responses/BadRequest'
1707 $ref: '#/components/responses/Unauthorized'
1709 $ref: '#/components/responses/Forbidden'
1711 $ref: '#/components/responses/NotFound'
1713 $ref: '#/components/responses/MethodNotAllowed'
1715 $ref: '#/components/responses/NotAcceptable'
1717 $ref: '#/components/responses/Conflict'
1719 $ref: '#/components/responses/UnprocessableEntity'
1721 $ref: '#/components/responses/InternalServerError'
1723 $ref: '#/components/responses/ServiceUnavailable'
1725 $ref: '#/components/responses/UnexpectedError'
1727 $ref: '#/components/responses/UnexpectedError'
1728 '/nslcm/v1/ns_instances/{nsInstanceId}/action':
1730 - name: nsInstanceId
1733 description: NS Instance ID
1739 summary: Execute an action on a NS instance
1741 Execute an action on a NS instance.
1742 The NS instance must have been created and must be in INSTANTIATED state.
1743 operationId: actionOnNSinstance
1748 $ref: '#/components/schemas/NSinstanceActionRequest'
1751 $ref: '#/components/schemas/NSinstanceActionRequest'
1754 description: Accepted
1758 It must point to the new "NS Lifecycle Operation Occurrence"
1759 resource, i.e. an URI like ".../ns_lcm_op_occs/{nsLcmOpOccId}"
1766 $ref: '#/components/schemas/ObjectId'
1769 $ref: '#/components/schemas/ObjectId'
1771 $ref: '#/components/responses/BadRequest'
1773 $ref: '#/components/responses/Unauthorized'
1775 $ref: '#/components/responses/Forbidden'
1777 $ref: '#/components/responses/NotFound'
1779 $ref: '#/components/responses/MethodNotAllowed'
1781 $ref: '#/components/responses/NotAcceptable'
1783 $ref: '#/components/responses/Conflict'
1785 $ref: '#/components/responses/UnprocessableEntity'
1787 $ref: '#/components/responses/InternalServerError'
1789 $ref: '#/components/responses/ServiceUnavailable'
1791 $ref: '#/components/responses/UnexpectedError'
1793 $ref: '#/components/responses/UnexpectedError'
1794 '/nslcm/v1/ns_instances/{nsInstanceId}/update':
1796 - name: nsInstanceId
1799 description: NS Instance ID
1805 summary: Update a NS instance
1807 Update a NS instance. The precondition is that the NS instance must have
1808 been created and must be in INSTANTIATED state. As a result of the
1809 success of this operation, the NFVO creates a "NS Lifecycle Operation
1810 Occurrence" resource for the request, and the NS instance state remains
1812 operationId: updateNSinstance
1814 $ref: '#/components/requestBodies/UpdateNsRequest'
1817 description: Accepted
1821 It must point to the new "NS Lifecycle Operation Occurrence"
1822 resource, i.e. an URI like ".../ns_lcm_op_occs/{nsLcmOpOccId}"
1827 $ref: '#/components/responses/BadRequest'
1829 $ref: '#/components/responses/Unauthorized'
1831 $ref: '#/components/responses/Forbidden'
1833 $ref: '#/components/responses/NotFound'
1835 $ref: '#/components/responses/MethodNotAllowed'
1837 $ref: '#/components/responses/NotAcceptable'
1839 $ref: '#/components/responses/Conflict'
1841 $ref: '#/components/responses/UnprocessableEntity'
1843 $ref: '#/components/responses/InternalServerError'
1845 $ref: '#/components/responses/ServiceUnavailable'
1847 $ref: '#/components/responses/UnexpectedError'
1849 $ref: '#/components/responses/UnexpectedError'
1850 '/nslcm/v1/ns_instances_content':
1854 summary: Query information about multiple NS instances
1855 description: Query information about multiple NS isntances
1856 operationId: getNSinstancesContent
1863 $ref: '#/components/schemas/ArrayOfNsInstance'
1866 $ref: '#/components/schemas/ArrayOfNsInstance'
1868 $ref: '#/components/responses/BadRequest'
1870 $ref: '#/components/responses/Unauthorized'
1872 $ref: '#/components/responses/Forbidden'
1874 $ref: '#/components/responses/NotFound'
1876 $ref: '#/components/responses/MethodNotAllowed'
1878 $ref: '#/components/responses/NotAcceptable'
1880 $ref: '#/components/responses/Conflict'
1882 $ref: '#/components/responses/UnprocessableEntity'
1884 $ref: '#/components/responses/InternalServerError'
1886 $ref: '#/components/responses/ServiceUnavailable'
1888 $ref: '#/components/responses/UnexpectedError'
1890 $ref: '#/components/responses/UnexpectedError'
1894 summary: Create a new NS instance
1895 description: Create a new NS instance
1896 operationId: createNSinstanceContent
1898 $ref: '#/components/requestBodies/InstantiateNsRequest'
1901 description: Created
1910 $ref: '#/components/schemas/CreateNSinstanceContentResponse'
1913 $ref: '#/components/schemas/CreateNSinstanceContentResponse'
1915 $ref: '#/components/responses/BadRequest'
1917 $ref: '#/components/responses/Unauthorized'
1919 $ref: '#/components/responses/Forbidden'
1921 $ref: '#/components/responses/NotFound'
1923 $ref: '#/components/responses/MethodNotAllowed'
1925 $ref: '#/components/responses/NotAcceptable'
1927 $ref: '#/components/responses/Conflict'
1929 $ref: '#/components/responses/UnprocessableEntity'
1931 $ref: '#/components/responses/InternalServerError'
1933 $ref: '#/components/responses/ServiceUnavailable'
1935 $ref: '#/components/responses/UnexpectedError'
1937 $ref: '#/components/responses/UnexpectedError'
1938 '/nslcm/v1/ns_instances_content/{nsInstanceContentId}':
1940 - name: nsInstanceContentId
1943 description: NS Instance Content ID
1949 summary: Read an individual NS instance resource
1950 description: Read an individual NS instance resource
1951 operationId: getNSinstanceContent
1958 $ref: '#/components/schemas/NsInstance'
1961 $ref: '#/components/schemas/NsInstance'
1963 $ref: '#/components/responses/BadRequest'
1965 $ref: '#/components/responses/Unauthorized'
1967 $ref: '#/components/responses/Forbidden'
1969 $ref: '#/components/responses/NotFound'
1971 $ref: '#/components/responses/MethodNotAllowed'
1973 $ref: '#/components/responses/NotAcceptable'
1975 $ref: '#/components/responses/Conflict'
1977 $ref: '#/components/responses/UnprocessableEntity'
1979 $ref: '#/components/responses/InternalServerError'
1981 $ref: '#/components/responses/ServiceUnavailable'
1983 $ref: '#/components/responses/UnexpectedError'
1985 $ref: '#/components/responses/UnexpectedError'
1989 summary: Delete an individual NS instance resource
1990 description: Delete an individual NS instance resource
1991 operationId: deleteNSinstanceContent
1994 description: Accepted
1998 $ref: '#/components/schemas/ObjectId'
2001 $ref: '#/components/schemas/ObjectId'
2003 description: No Content
2005 $ref: '#/components/responses/BadRequest'
2007 $ref: '#/components/responses/Unauthorized'
2009 $ref: '#/components/responses/Forbidden'
2011 $ref: '#/components/responses/NotFound'
2013 $ref: '#/components/responses/MethodNotAllowed'
2015 $ref: '#/components/responses/NotAcceptable'
2017 $ref: '#/components/responses/Conflict'
2019 $ref: '#/components/responses/UnprocessableEntity'
2021 $ref: '#/components/responses/InternalServerError'
2023 $ref: '#/components/responses/ServiceUnavailable'
2025 $ref: '#/components/responses/UnexpectedError'
2027 $ref: '#/components/responses/UnexpectedError'
2028 '/nslcm/v1/ns_lcm_op_occs':
2032 summary: Query information about multiple NS LCM Operation Occurrences
2033 description: Query information about multiple NS LCM Operation Occurrences
2034 operationId: getNSLCMOpOccs
2041 $ref: '#/components/schemas/ArrayOfNsLcmOpOcc'
2044 $ref: '#/components/schemas/ArrayOfNsLcmOpOcc'
2046 $ref: '#/components/responses/BadRequest'
2048 $ref: '#/components/responses/Unauthorized'
2050 $ref: '#/components/responses/Forbidden'
2052 $ref: '#/components/responses/NotFound'
2054 $ref: '#/components/responses/MethodNotAllowed'
2056 $ref: '#/components/responses/NotAcceptable'
2058 $ref: '#/components/responses/Conflict'
2060 $ref: '#/components/responses/UnprocessableEntity'
2062 $ref: '#/components/responses/InternalServerError'
2064 $ref: '#/components/responses/ServiceUnavailable'
2066 $ref: '#/components/responses/UnexpectedError'
2068 $ref: '#/components/responses/UnexpectedError'
2069 '/nslcm/v1/ns_lcm_op_occs/{nsLcmOpOccId}':
2071 - name: nsLcmOpOccId
2074 description: NS LCM Operation Occurrence ID
2080 summary: Query information about an individual NS LCM Operation Occurrence
2081 description: Query information about an individual NS LCM Operation Occurrence
2082 operationId: getNSLCMOpOcc
2089 $ref: '#/components/schemas/NsLcmOpOcc'
2092 $ref: '#/components/schemas/NsLcmOpOcc'
2094 $ref: '#/components/responses/BadRequest'
2096 $ref: '#/components/responses/Unauthorized'
2098 $ref: '#/components/responses/Forbidden'
2100 $ref: '#/components/responses/NotFound'
2102 $ref: '#/components/responses/MethodNotAllowed'
2104 $ref: '#/components/responses/NotAcceptable'
2106 $ref: '#/components/responses/Conflict'
2108 $ref: '#/components/responses/UnprocessableEntity'
2110 $ref: '#/components/responses/InternalServerError'
2112 $ref: '#/components/responses/ServiceUnavailable'
2114 $ref: '#/components/responses/UnexpectedError'
2116 $ref: '#/components/responses/UnexpectedError'
2117 '/nslcm/v1/vnf_instances':
2121 summary: Query information about multiple VNF Instances
2122 description: Query information about multiple VNF Instances
2123 operationId: getVnfInstances
2130 $ref: '#/components/schemas/ArrayOfVnfInstanceInfo'
2133 $ref: '#/components/schemas/ArrayOfVnfInstanceInfo'
2135 $ref: '#/components/responses/BadRequest'
2137 $ref: '#/components/responses/Unauthorized'
2139 $ref: '#/components/responses/Forbidden'
2141 $ref: '#/components/responses/NotFound'
2143 $ref: '#/components/responses/MethodNotAllowed'
2145 $ref: '#/components/responses/NotAcceptable'
2147 $ref: '#/components/responses/Conflict'
2149 $ref: '#/components/responses/UnprocessableEntity'
2151 $ref: '#/components/responses/InternalServerError'
2153 $ref: '#/components/responses/ServiceUnavailable'
2155 $ref: '#/components/responses/UnexpectedError'
2157 $ref: '#/components/responses/UnexpectedError'
2158 '/nslcm/v1/vnf_instances/{vnfInstanceId}':
2160 - name: vnfInstanceId
2163 description: VNF Instance ID
2169 summary: Query information about an individual VNF Instance
2170 description: Query information about an individual VNF Instance
2171 operationId: getVnfInstance
2178 $ref: '#/components/schemas/VnfInstanceInfo'
2181 $ref: '#/components/schemas/VnfInstanceInfo'
2183 $ref: '#/components/responses/BadRequest'
2185 $ref: '#/components/responses/Unauthorized'
2187 $ref: '#/components/responses/Forbidden'
2189 $ref: '#/components/responses/NotFound'
2191 $ref: '#/components/responses/MethodNotAllowed'
2193 $ref: '#/components/responses/NotAcceptable'
2195 $ref: '#/components/responses/Conflict'
2197 $ref: '#/components/responses/UnprocessableEntity'
2199 $ref: '#/components/responses/InternalServerError'
2201 $ref: '#/components/responses/ServiceUnavailable'
2203 $ref: '#/components/responses/UnexpectedError'
2205 $ref: '#/components/responses/UnexpectedError'
2206 '/nslcm/v1/subscriptions':
2210 summary: Query information about multiple NS instance subscription
2211 description: Query information about multiple NS instance subscription
2212 operationId: getNsSubcriptions
2219 $ref: '#/components/schemas/ArrayOfNslcmSubscriptionInfo'
2222 $ref: '#/components/schemas/ArrayOfNslcmSubscriptionInfo'
2224 $ref: '#/components/responses/BadRequest'
2226 $ref: '#/components/responses/Unauthorized'
2228 $ref: '#/components/responses/Forbidden'
2230 $ref: '#/components/responses/NotFound'
2232 $ref: '#/components/responses/MethodNotAllowed'
2234 $ref: '#/components/responses/NotAcceptable'
2236 $ref: '#/components/responses/Conflict'
2238 $ref: '#/components/responses/UnprocessableEntity'
2240 $ref: '#/components/responses/InternalServerError'
2242 $ref: '#/components/responses/ServiceUnavailable'
2244 $ref: '#/components/responses/UnexpectedError'
2246 $ref: '#/components/responses/UnexpectedError'
2250 summary: Create a new subscription for the Network service
2251 description: Create a new subscription for the Network service
2252 operationId: addNsSubcriptions
2254 $ref: '#/components/requestBodies/NslcmSubscriptionRequest'
2257 description: Created
2265 $ref: '#/components/schemas/NslcmSubscriptionResponse'
2268 $ref: '#/components/schemas/NslcmSubscriptionResponse'
2270 $ref: '#/components/responses/BadRequest'
2272 $ref: '#/components/responses/Unauthorized'
2274 $ref: '#/components/responses/Forbidden'
2276 $ref: '#/components/responses/NotFound'
2278 $ref: '#/components/responses/MethodNotAllowed'
2280 $ref: '#/components/responses/NotAcceptable'
2282 $ref: '#/components/responses/Conflict'
2284 $ref: '#/components/responses/UnprocessableEntity'
2286 $ref: '#/components/responses/InternalServerError'
2288 $ref: '#/components/responses/ServiceUnavailable'
2290 $ref: '#/components/responses/UnexpectedError'
2292 $ref: '#/components/responses/UnexpectedError'
2293 '/nslcm/v1/subscriptions/{nsSubscriptionsId}':
2295 - name: nsSubscriptionsId
2298 description: Network Service Subscription ID
2304 summary: Read information about an individual Network Service Subscription
2305 description: Read information about an individual Network Service Subscription
2306 operationId: getNsSubcriptionId
2313 $ref: '#/components/schemas/NslcmSubscriptionInfo'
2316 $ref: '#/components/schemas/NslcmSubscriptionInfo'
2318 $ref: '#/components/responses/BadRequest'
2320 $ref: '#/components/responses/Unauthorized'
2322 $ref: '#/components/responses/Forbidden'
2324 $ref: '#/components/responses/NotFound'
2326 $ref: '#/components/responses/MethodNotAllowed'
2328 $ref: '#/components/responses/NotAcceptable'
2330 $ref: '#/components/responses/Conflict'
2332 $ref: '#/components/responses/UnprocessableEntity'
2334 $ref: '#/components/responses/InternalServerError'
2336 $ref: '#/components/responses/ServiceUnavailable'
2338 $ref: '#/components/responses/UnexpectedError'
2340 $ref: '#/components/responses/UnexpectedError'
2344 summary: Delete an individual Network Service Subscription
2345 description: Delete an individual Network Service Subscription
2346 operationId: deleteNsSubcriptionId
2349 description: No Content
2351 $ref: '#/components/responses/BadRequest'
2353 $ref: '#/components/responses/Unauthorized'
2355 $ref: '#/components/responses/Forbidden'
2357 $ref: '#/components/responses/NotFound'
2359 $ref: '#/components/responses/MethodNotAllowed'
2361 $ref: '#/components/responses/NotAcceptable'
2363 $ref: '#/components/responses/Conflict'
2365 $ref: '#/components/responses/UnprocessableEntity'
2367 $ref: '#/components/responses/InternalServerError'
2369 $ref: '#/components/responses/ServiceUnavailable'
2371 $ref: '#/components/responses/UnexpectedError'
2373 $ref: '#/components/responses/UnexpectedError'
2381 summary: Query information about multiple alarms
2382 description: Query information about multiple alarms
2383 operationId: getAlarms
2390 $ref: '#/components/schemas/ArrayOfAlarm'
2393 $ref: '#/components/schemas/ArrayOfAlarm'
2395 $ref: '#/components/responses/BadRequest'
2397 $ref: '#/components/responses/Unauthorized'
2399 $ref: '#/components/responses/Forbidden'
2401 $ref: '#/components/responses/NotFound'
2403 $ref: '#/components/responses/MethodNotAllowed'
2405 $ref: '#/components/responses/NotAcceptable'
2407 $ref: '#/components/responses/Conflict'
2409 $ref: '#/components/responses/UnprocessableEntity'
2411 $ref: '#/components/responses/InternalServerError'
2413 $ref: '#/components/responses/ServiceUnavailable'
2415 $ref: '#/components/responses/UnexpectedError'
2417 $ref: '#/components/responses/UnexpectedError'
2418 '/nsfm/v1/alarms/{uuid}':
2423 description: Alarm UUID
2429 summary: Read an individual Alarm
2430 description: Read an individual Alarm
2431 operationId: getAlarm
2438 $ref: '#/components/schemas/Alarm'
2441 $ref: '#/components/schemas/Alarm'
2443 $ref: '#/components/responses/BadRequest'
2445 $ref: '#/components/responses/Unauthorized'
2447 $ref: '#/components/responses/Forbidden'
2449 $ref: '#/components/responses/NotFound'
2451 $ref: '#/components/responses/MethodNotAllowed'
2453 $ref: '#/components/responses/NotAcceptable'
2455 $ref: '#/components/responses/Conflict'
2457 $ref: '#/components/responses/UnprocessableEntity'
2459 $ref: '#/components/responses/InternalServerError'
2461 $ref: '#/components/responses/ServiceUnavailable'
2463 $ref: '#/components/responses/UnexpectedError'
2465 $ref: '#/components/responses/UnexpectedError'
2469 summary: Modify the data of an individual Alarm
2470 description: Modify the data of an individual Alarm
2471 operationId: updateAlarm
2473 $ref: '#/components/requestBodies/AlarmInfoModifications'
2476 description: No Content
2478 $ref: '#/components/responses/BadRequest'
2480 $ref: '#/components/responses/Unauthorized'
2482 $ref: '#/components/responses/Forbidden'
2484 $ref: '#/components/responses/NotFound'
2486 $ref: '#/components/responses/MethodNotAllowed'
2488 $ref: '#/components/responses/NotAcceptable'
2490 $ref: '#/components/responses/Conflict'
2492 $ref: '#/components/responses/UnprocessableEntity'
2494 $ref: '#/components/responses/InternalServerError'
2496 $ref: '#/components/responses/ServiceUnavailable'
2498 $ref: '#/components/responses/UnexpectedError'
2500 $ref: '#/components/responses/UnexpectedError'
2503 # BEGIN NetSlice Templates
2504 '/nst/v1/netslice_templates':
2507 - "NetSlice templates"
2508 summary: Query information about multiple NetSlice template resources
2509 description: Query information about multiple NetSlice template resources
2510 operationId: getNSTs
2517 $ref: '#/components/schemas/ArrayOfNstInfo'
2520 $ref: '#/components/schemas/ArrayOfNstInfo'
2522 $ref: '#/components/responses/BadRequest'
2524 $ref: '#/components/responses/Unauthorized'
2526 $ref: '#/components/responses/Forbidden'
2528 $ref: '#/components/responses/NotFound'
2530 $ref: '#/components/responses/MethodNotAllowed'
2532 $ref: '#/components/responses/NotAcceptable'
2534 $ref: '#/components/responses/Conflict'
2536 $ref: '#/components/responses/UnprocessableEntity'
2538 $ref: '#/components/responses/InternalServerError'
2540 $ref: '#/components/responses/ServiceUnavailable'
2542 $ref: '#/components/responses/UnexpectedError'
2544 $ref: '#/components/responses/UnexpectedError'
2547 - "NetSlice templates"
2548 summary: Create a new NetSlice template resource
2549 description: Create a new NetSlice template resource
2552 $ref: '#/components/requestBodies/CreateNstInfoRequest'
2555 description: Created
2564 $ref: '#/components/schemas/ObjectId'
2567 $ref: '#/components/schemas/ObjectId'
2569 $ref: '#/components/responses/BadRequest'
2571 $ref: '#/components/responses/Unauthorized'
2573 $ref: '#/components/responses/Forbidden'
2575 $ref: '#/components/responses/NotFound'
2577 $ref: '#/components/responses/MethodNotAllowed'
2579 $ref: '#/components/responses/NotAcceptable'
2581 $ref: '#/components/responses/Conflict'
2583 $ref: '#/components/responses/UnprocessableEntity'
2585 $ref: '#/components/responses/InternalServerError'
2587 $ref: '#/components/responses/ServiceUnavailable'
2589 $ref: '#/components/responses/UnexpectedError'
2591 $ref: '#/components/responses/UnexpectedError'
2592 '/nst/v1/netslice_templates/{netsliceTemplateId}':
2594 - name: netsliceTemplateId
2597 description: NetSlice Template ID
2602 - "NetSlice templates"
2603 summary: Read information about an individual NetSlice template resource
2604 description: Read information about an individual NetSlice template resource
2612 $ref: '#/components/schemas/NstInfo'
2615 $ref: '#/components/schemas/NstInfo'
2617 $ref: '#/components/responses/BadRequest'
2619 $ref: '#/components/responses/Unauthorized'
2621 $ref: '#/components/responses/Forbidden'
2623 $ref: '#/components/responses/NotFound'
2625 $ref: '#/components/responses/MethodNotAllowed'
2627 $ref: '#/components/responses/NotAcceptable'
2629 $ref: '#/components/responses/Conflict'
2631 $ref: '#/components/responses/UnprocessableEntity'
2633 $ref: '#/components/responses/InternalServerError'
2635 $ref: '#/components/responses/ServiceUnavailable'
2637 $ref: '#/components/responses/UnexpectedError'
2639 $ref: '#/components/responses/UnexpectedError'
2642 - "NetSlice templates"
2643 summary: Delete an individual NetSlice template resource
2644 description: Delete an individual NetSlice template resource
2645 operationId: deleteNST
2648 description: No Content
2650 $ref: '#/components/responses/BadRequest'
2652 $ref: '#/components/responses/Unauthorized'
2654 $ref: '#/components/responses/Forbidden'
2656 $ref: '#/components/responses/NotFound'
2658 $ref: '#/components/responses/MethodNotAllowed'
2660 $ref: '#/components/responses/NotAcceptable'
2662 $ref: '#/components/responses/Conflict'
2664 $ref: '#/components/responses/UnprocessableEntity'
2666 $ref: '#/components/responses/InternalServerError'
2668 $ref: '#/components/responses/ServiceUnavailable'
2670 $ref: '#/components/responses/UnexpectedError'
2672 $ref: '#/components/responses/UnexpectedError'
2673 '/nst/v1/netslice_templates/{netsliceTemplateId}/artifacts/{artifactPath}':
2675 - name: netsliceTemplateId
2678 description: NetSlice Template ID
2681 - name: artifactPath
2684 description: Artifact Path
2689 - "NetSlice templates"
2690 summary: Fetch individual NetSlice Template artifact
2691 description: Fetch individual NetSlice Template artifact
2692 operationId: getNstArtifact
2697 application/octet-stream:
2702 description: Partial Content
2708 application/octet-stream:
2713 $ref: '#/components/responses/BadRequest'
2715 $ref: '#/components/responses/Unauthorized'
2717 $ref: '#/components/responses/Forbidden'
2719 $ref: '#/components/responses/NotFound'
2721 $ref: '#/components/responses/MethodNotAllowed'
2723 $ref: '#/components/responses/NotAcceptable'
2725 $ref: '#/components/responses/Conflict'
2727 $ref: '#/components/responses/UnprocessableEntity'
2729 $ref: '#/components/responses/InternalServerError'
2731 $ref: '#/components/responses/ServiceUnavailable'
2733 $ref: '#/components/responses/UnexpectedError'
2735 $ref: '#/components/responses/UnexpectedError'
2736 '/nst/v1/netslice_templates/{netsliceTemplateId}/nst':
2738 - name: netsliceTemplateId
2741 description: NetSlice Template ID
2746 - "NetSlice templates"
2747 summary: Read NST of an on-boarded NetSlice Template
2748 description: Read NST of an on-boarded NetSlice Template
2749 operationId: getNstNst
2756 $ref: '#/components/schemas/NetSliceTemplate'
2758 $ref: '#/components/responses/BadRequest'
2760 $ref: '#/components/responses/Unauthorized'
2762 $ref: '#/components/responses/Forbidden'
2764 $ref: '#/components/responses/NotFound'
2766 $ref: '#/components/responses/MethodNotAllowed'
2768 $ref: '#/components/responses/NotAcceptable'
2770 $ref: '#/components/responses/Conflict'
2772 $ref: '#/components/responses/UnprocessableEntity'
2774 $ref: '#/components/responses/InternalServerError'
2776 $ref: '#/components/responses/ServiceUnavailable'
2778 $ref: '#/components/responses/UnexpectedError'
2780 $ref: '#/components/responses/UnexpectedError'
2781 '/nst/v1/netslice_templates/{netsliceTemplateId}/nst_content':
2783 - name: netsliceTemplateId
2786 description: NetSlice Template ID
2791 - "NetSlice templates"
2792 summary: Fetch the content of a NST
2793 description: Fetch the content of a NST
2794 operationId: getNSTcontent
2801 $ref: '#/components/schemas/NetSlicePackage'
2803 description: Partial Content
2811 $ref: '#/components/schemas/NetSlicePackage'
2813 $ref: '#/components/responses/BadRequest'
2815 $ref: '#/components/responses/Unauthorized'
2817 $ref: '#/components/responses/Forbidden'
2819 $ref: '#/components/responses/NotFound'
2821 $ref: '#/components/responses/MethodNotAllowed'
2823 $ref: '#/components/responses/NotAcceptable'
2825 $ref: '#/components/responses/Conflict'
2827 $ref: '#/components/responses/UnprocessableEntity'
2829 $ref: '#/components/responses/InternalServerError'
2831 $ref: '#/components/responses/ServiceUnavailable'
2833 $ref: '#/components/responses/UnexpectedError'
2835 $ref: '#/components/responses/UnexpectedError'
2838 - "NetSlice templates"
2839 summary: Upload the content of a NST
2840 description: Upload the content of a NST
2841 operationId: updateNSTcontent
2843 $ref: '#/components/requestBodies/NetSlicePackage'
2846 description: Accepted
2848 description: No Content
2850 $ref: '#/components/responses/BadRequest'
2852 $ref: '#/components/responses/Unauthorized'
2854 $ref: '#/components/responses/Forbidden'
2856 $ref: '#/components/responses/NotFound'
2858 $ref: '#/components/responses/MethodNotAllowed'
2860 $ref: '#/components/responses/NotAcceptable'
2862 $ref: '#/components/responses/Conflict'
2864 $ref: '#/components/responses/UnprocessableEntity'
2866 $ref: '#/components/responses/InternalServerError'
2868 $ref: '#/components/responses/ServiceUnavailable'
2870 $ref: '#/components/responses/UnexpectedError'
2872 $ref: '#/components/responses/UnexpectedError'
2873 '/nst/v1/netslice_templates_content':
2876 - "NetSlice templates"
2877 summary: Upload a NetSlice package by providing the content of the NetSlice package
2878 description: Upload a NetSlice package by providing the content of the NetSlice package
2879 operationId: uploadNstContent
2884 $ref: '#/components/schemas/NetSlicePackage'
2887 description: Created
2896 $ref: '#/components/schemas/ObjectId'
2899 $ref: '#/components/schemas/ObjectId'
2901 description: Accepted
2903 description: No Content
2905 $ref: '#/components/responses/BadRequest'
2907 $ref: '#/components/responses/Unauthorized'
2909 $ref: '#/components/responses/Forbidden'
2911 $ref: '#/components/responses/NotFound'
2913 $ref: '#/components/responses/MethodNotAllowed'
2915 $ref: '#/components/responses/NotAcceptable'
2917 $ref: '#/components/responses/Conflict'
2919 $ref: '#/components/responses/UnprocessableEntity'
2921 $ref: '#/components/responses/InternalServerError'
2923 $ref: '#/components/responses/ServiceUnavailable'
2925 $ref: '#/components/responses/UnexpectedError'
2927 $ref: '#/components/responses/UnexpectedError'
2930 - "NetSlice templates"
2931 summary: Query information about multiple NetSlice Template resources
2932 description: Query information about multiple NetSlice Template resources
2933 operationId: getNstContent
2940 $ref: '#/components/schemas/ArrayOfNstInfo'
2943 $ref: '#/components/schemas/ArrayOfNstInfo'
2945 description: Partial Content
2951 application/octet-stream:
2956 $ref: '#/components/responses/BadRequest'
2958 $ref: '#/components/responses/Unauthorized'
2960 $ref: '#/components/responses/Forbidden'
2962 $ref: '#/components/responses/NotFound'
2964 $ref: '#/components/responses/MethodNotAllowed'
2966 $ref: '#/components/responses/NotAcceptable'
2968 $ref: '#/components/responses/Conflict'
2970 $ref: '#/components/responses/UnprocessableEntity'
2972 $ref: '#/components/responses/InternalServerError'
2974 $ref: '#/components/responses/ServiceUnavailable'
2976 $ref: '#/components/responses/UnexpectedError'
2978 $ref: '#/components/responses/UnexpectedError'
2979 '/nst/v1/netslice_templates_content/{netsliceTemplateContentId}':
2981 - name: netsliceTemplateContentId
2984 description: NetSlice Template ID
2989 - "NetSlice templates"
2990 summary: Read information about an individual NetSlice Template resource
2991 description: Read information about an individual NetSlice Template resource
2992 operationId: getNstIdContent
2999 $ref: '#/components/schemas/NstInfo'
3002 $ref: '#/components/schemas/NstInfo'
3004 $ref: '#/components/responses/BadRequest'
3006 $ref: '#/components/responses/Unauthorized'
3008 $ref: '#/components/responses/Forbidden'
3010 $ref: '#/components/responses/NotFound'
3012 $ref: '#/components/responses/MethodNotAllowed'
3014 $ref: '#/components/responses/NotAcceptable'
3016 $ref: '#/components/responses/Conflict'
3018 $ref: '#/components/responses/UnprocessableEntity'
3020 $ref: '#/components/responses/InternalServerError'
3022 $ref: '#/components/responses/ServiceUnavailable'
3024 $ref: '#/components/responses/UnexpectedError'
3026 $ref: '#/components/responses/UnexpectedError'
3029 - "NetSlice templates"
3030 summary: Modify an individual NetSlice Template resource
3031 description: Modify an individual NetSlice Template resource
3032 operationId: updateNstIdContent
3034 $ref: '#/components/requestBodies/NstInfoModifications'
3037 description: No Content
3039 $ref: '#/components/responses/BadRequest'
3041 $ref: '#/components/responses/Unauthorized'
3043 $ref: '#/components/responses/Forbidden'
3045 $ref: '#/components/responses/NotFound'
3047 $ref: '#/components/responses/MethodNotAllowed'
3049 $ref: '#/components/responses/NotAcceptable'
3051 $ref: '#/components/responses/Conflict'
3053 $ref: '#/components/responses/UnprocessableEntity'
3055 $ref: '#/components/responses/InternalServerError'
3057 $ref: '#/components/responses/ServiceUnavailable'
3059 $ref: '#/components/responses/UnexpectedError'
3061 $ref: '#/components/responses/UnexpectedError'
3064 - "NetSlice templates"
3065 summary: Delete an individual NetSlice Template resource
3066 description: Delete an individual NetSlice Template resource
3067 operationId: deleteNstIdContent
3070 description: No Content
3072 $ref: '#/components/responses/BadRequest'
3074 $ref: '#/components/responses/Unauthorized'
3076 $ref: '#/components/responses/Forbidden'
3078 $ref: '#/components/responses/NotFound'
3080 $ref: '#/components/responses/MethodNotAllowed'
3082 $ref: '#/components/responses/NotAcceptable'
3084 $ref: '#/components/responses/Conflict'
3086 $ref: '#/components/responses/UnprocessableEntity'
3088 $ref: '#/components/responses/InternalServerError'
3090 $ref: '#/components/responses/ServiceUnavailable'
3092 $ref: '#/components/responses/UnexpectedError'
3094 $ref: '#/components/responses/UnexpectedError'
3095 # END NetSlice Templates
3097 # BEGIN NetSlice Instances
3098 '/nsilcm/v1/netslice_instances':
3101 - "NetSlice instances"
3102 summary: Query information about multiple NetSlice instances
3103 description: Query information about multiple NetSlice isntances
3104 operationId: getNSIs
3111 $ref: '#/components/schemas/ArrayOfNetSliceInstance'
3114 $ref: '#/components/schemas/ArrayOfNetSliceInstance'
3116 $ref: '#/components/responses/BadRequest'
3118 $ref: '#/components/responses/Unauthorized'
3120 $ref: '#/components/responses/Forbidden'
3122 $ref: '#/components/responses/NotFound'
3124 $ref: '#/components/responses/MethodNotAllowed'
3126 $ref: '#/components/responses/NotAcceptable'
3128 $ref: '#/components/responses/Conflict'
3130 $ref: '#/components/responses/UnprocessableEntity'
3132 $ref: '#/components/responses/InternalServerError'
3134 $ref: '#/components/responses/ServiceUnavailable'
3136 $ref: '#/components/responses/UnexpectedError'
3138 $ref: '#/components/responses/UnexpectedError'
3141 - "NetSlice instances"
3142 summary: Create a new NetSlice instance resource
3143 description: Create a new NetSlice instance resource
3146 $ref: '#/components/requestBodies/InstantiateNsiRequest'
3149 description: Created
3158 $ref: '#/components/schemas/ObjectId'
3161 $ref: '#/components/schemas/ObjectId'
3163 $ref: '#/components/responses/BadRequest'
3165 $ref: '#/components/responses/Unauthorized'
3167 $ref: '#/components/responses/Forbidden'
3169 $ref: '#/components/responses/NotFound'
3171 $ref: '#/components/responses/MethodNotAllowed'
3173 $ref: '#/components/responses/NotAcceptable'
3175 $ref: '#/components/responses/Conflict'
3177 $ref: '#/components/responses/UnprocessableEntity'
3179 $ref: '#/components/responses/InternalServerError'
3181 $ref: '#/components/responses/ServiceUnavailable'
3183 $ref: '#/components/responses/UnexpectedError'
3185 $ref: '#/components/responses/UnexpectedError'
3186 '/nsilcm/v1/netslice_instances/{netsliceInstanceId}':
3188 - name: netsliceInstanceId
3191 description: NetSlice Instance ID
3196 - "NetSlice instances"
3197 summary: Read an individual NetSlice instance resource
3198 description: Read an individual NetSlice instance resource
3206 $ref: '#/components/schemas/NetSliceInstance'
3209 $ref: '#/components/schemas/NetSliceInstance'
3211 $ref: '#/components/responses/BadRequest'
3213 $ref: '#/components/responses/Unauthorized'
3215 $ref: '#/components/responses/Forbidden'
3217 $ref: '#/components/responses/NotFound'
3219 $ref: '#/components/responses/MethodNotAllowed'
3221 $ref: '#/components/responses/NotAcceptable'
3223 $ref: '#/components/responses/Conflict'
3225 $ref: '#/components/responses/UnprocessableEntity'
3227 $ref: '#/components/responses/InternalServerError'
3229 $ref: '#/components/responses/ServiceUnavailable'
3231 $ref: '#/components/responses/UnexpectedError'
3233 $ref: '#/components/responses/UnexpectedError'
3236 - "NetSlice instances"
3237 summary: Delete an individual NetSlice instance resource
3238 description: Delete an individual NetSlice instance resource
3239 operationId: deleteNSI
3242 description: No Content
3244 $ref: '#/components/responses/BadRequest'
3246 $ref: '#/components/responses/Unauthorized'
3248 $ref: '#/components/responses/Forbidden'
3250 $ref: '#/components/responses/NotFound'
3252 $ref: '#/components/responses/MethodNotAllowed'
3254 $ref: '#/components/responses/NotAcceptable'
3256 $ref: '#/components/responses/Conflict'
3258 $ref: '#/components/responses/UnprocessableEntity'
3260 $ref: '#/components/responses/InternalServerError'
3262 $ref: '#/components/responses/ServiceUnavailable'
3264 $ref: '#/components/responses/UnexpectedError'
3266 $ref: '#/components/responses/UnexpectedError'
3267 '/nsilcm/v1/netslice_instances/{netsliceInstanceId}/instantiate':
3269 - name: netsliceInstanceId
3272 description: NetSlice Instance ID
3277 - "NetSlice instances"
3278 summary: Instantiate a NetSlice
3280 Instantiate a NetSlice. The precondition is that the NetSlice instance
3281 must have been created and must be in NOT_INSTANTIATED state. As a result
3282 of the success of this operation, the NFVO creates a "NetSlice Lifecycle
3283 Operation Occurrence" resource for the request, and the NS instance state
3284 becomes INSTANTIATED.
3285 operationId: instantiateNSI
3287 $ref: '#/components/requestBodies/InstantiateNsiRequest'
3290 description: Accepted
3294 It must point to the new "NetSlice Lifecycle Operation Occurrence"
3295 resource, i.e. an URI like ".../nsi_lcm_op_occs/{nsiLcmOpOccId}"
3302 $ref: '#/components/schemas/ObjectId'
3305 $ref: '#/components/schemas/ObjectId'
3307 $ref: '#/components/responses/BadRequest'
3309 $ref: '#/components/responses/Unauthorized'
3311 $ref: '#/components/responses/Forbidden'
3313 $ref: '#/components/responses/NotFound'
3315 $ref: '#/components/responses/MethodNotAllowed'
3317 $ref: '#/components/responses/NotAcceptable'
3319 $ref: '#/components/responses/Conflict'
3321 $ref: '#/components/responses/UnprocessableEntity'
3323 $ref: '#/components/responses/InternalServerError'
3325 $ref: '#/components/responses/ServiceUnavailable'
3327 $ref: '#/components/responses/UnexpectedError'
3329 $ref: '#/components/responses/UnexpectedError'
3330 '/nsilcm/v1/netslice_instances/{netsliceInstanceId}/terminate':
3332 - name: netsliceInstanceId
3335 description: NetSlice Instance ID
3340 - "NetSlice instances"
3341 summary: Terminate a NetSlice instance
3343 Terminate a NetSlice instance. The precondition is that the NetSlice instance
3344 must have been created and must be in INSTANTIATED state. As a result of the
3345 success of this operation, the NFVO creates a "NetSlice Lifecycle Operation
3346 Occurrence" resource for the request, and the NetSlice instance state becomes
3348 operationId: terminateNSI
3350 # Request data is not required
3351 $ref: '#/components/requestBodies/TerminateNsiRequest'
3354 description: Accepted
3358 It must point to the new "NetSlice Lifecycle Operation Occurrence"
3359 resource, i.e. an URI like ".../nsi_lcm_op_occs/{nsiLcmOpOccId}"
3366 $ref: '#/components/schemas/ObjectId'
3369 $ref: '#/components/schemas/ObjectId'
3371 $ref: '#/components/responses/BadRequest'
3373 $ref: '#/components/responses/Unauthorized'
3375 $ref: '#/components/responses/Forbidden'
3377 $ref: '#/components/responses/NotFound'
3379 $ref: '#/components/responses/MethodNotAllowed'
3381 $ref: '#/components/responses/NotAcceptable'
3383 $ref: '#/components/responses/Conflict'
3385 $ref: '#/components/responses/UnprocessableEntity'
3387 $ref: '#/components/responses/InternalServerError'
3389 $ref: '#/components/responses/ServiceUnavailable'
3391 $ref: '#/components/responses/UnexpectedError'
3393 $ref: '#/components/responses/UnexpectedError'
3394 '/nsilcm/v1/netslice_instances/{netsliceInstanceId}/action':
3396 - name: netsliceInstanceId
3399 description: NetSlice Instance ID
3404 - "NetSlice instances"
3405 summary: Execute an action on a NetSlice instance
3407 Execute an action on a NetSlice instance.
3408 The NetSlice instance must have been created and must be in INSTANTIATED state.
3409 operationId: actionOnNSI
3414 $ref: '#/components/schemas/NsiActionRequest'
3417 $ref: '#/components/schemas/NsiActionRequest'
3420 description: Accepted
3424 It must point to the new "NS Lifecycle Operation Occurrence"
3425 resource, i.e. an URI like ".../ns_lcm_op_occs/{nsLcmOpOccId}"
3432 $ref: '#/components/schemas/ObjectId'
3435 $ref: '#/components/schemas/ObjectId'
3437 $ref: '#/components/responses/BadRequest'
3439 $ref: '#/components/responses/Unauthorized'
3441 $ref: '#/components/responses/Forbidden'
3443 $ref: '#/components/responses/NotFound'
3445 $ref: '#/components/responses/MethodNotAllowed'
3447 $ref: '#/components/responses/NotAcceptable'
3449 $ref: '#/components/responses/Conflict'
3451 $ref: '#/components/responses/UnprocessableEntity'
3453 $ref: '#/components/responses/InternalServerError'
3455 $ref: '#/components/responses/ServiceUnavailable'
3457 $ref: '#/components/responses/UnexpectedError'
3459 $ref: '#/components/responses/UnexpectedError'
3460 '/nsilcm/v1/netslice_instances_content':
3463 - "NetSlice instances"
3464 summary: Query information about multiple NetSlice instances
3465 description: Query information about multiple NetSlice isntances
3466 operationId: getNSIsContent
3473 $ref: '#/components/schemas/ArrayOfNetSliceInstance'
3476 $ref: '#/components/schemas/ArrayOfNetSliceInstance'
3478 $ref: '#/components/responses/BadRequest'
3480 $ref: '#/components/responses/Unauthorized'
3482 $ref: '#/components/responses/Forbidden'
3484 $ref: '#/components/responses/NotFound'
3486 $ref: '#/components/responses/MethodNotAllowed'
3488 $ref: '#/components/responses/NotAcceptable'
3490 $ref: '#/components/responses/Conflict'
3492 $ref: '#/components/responses/UnprocessableEntity'
3494 $ref: '#/components/responses/InternalServerError'
3496 $ref: '#/components/responses/ServiceUnavailable'
3498 $ref: '#/components/responses/UnexpectedError'
3500 $ref: '#/components/responses/UnexpectedError'
3503 - "NetSlice instances"
3504 summary: Create a new NetSlice instance
3505 description: Create a new NetSlice instance
3506 operationId: createNSIContent
3508 $ref: '#/components/requestBodies/InstantiateNsiRequest'
3511 description: Created
3520 $ref: '#/components/schemas/CreateNsiContentResponse'
3523 $ref: '#/components/schemas/CreateNsiContentResponse'
3525 $ref: '#/components/responses/BadRequest'
3527 $ref: '#/components/responses/Unauthorized'
3529 $ref: '#/components/responses/Forbidden'
3531 $ref: '#/components/responses/NotFound'
3533 $ref: '#/components/responses/MethodNotAllowed'
3535 $ref: '#/components/responses/NotAcceptable'
3537 $ref: '#/components/responses/Conflict'
3539 $ref: '#/components/responses/UnprocessableEntity'
3541 $ref: '#/components/responses/InternalServerError'
3543 $ref: '#/components/responses/ServiceUnavailable'
3545 $ref: '#/components/responses/UnexpectedError'
3547 $ref: '#/components/responses/UnexpectedError'
3548 '/nsilcm/v1/netslice_instances_content/{netsliceInstanceContentId}':
3550 - name: netsliceInstanceContentId
3553 description: NetSlice Instance Content ID
3558 - "NetSlice instances"
3559 summary: Read an individual NetSlice instance resource
3560 description: Read an individual NetSlice instance resource
3561 operationId: getNSIContent
3568 $ref: '#/components/schemas/NetSliceInstance'
3571 $ref: '#/components/schemas/NetSliceInstance'
3573 $ref: '#/components/responses/BadRequest'
3575 $ref: '#/components/responses/Unauthorized'
3577 $ref: '#/components/responses/Forbidden'
3579 $ref: '#/components/responses/NotFound'
3581 $ref: '#/components/responses/MethodNotAllowed'
3583 $ref: '#/components/responses/NotAcceptable'
3585 $ref: '#/components/responses/Conflict'
3587 $ref: '#/components/responses/UnprocessableEntity'
3589 $ref: '#/components/responses/InternalServerError'
3591 $ref: '#/components/responses/ServiceUnavailable'
3593 $ref: '#/components/responses/UnexpectedError'
3595 $ref: '#/components/responses/UnexpectedError'
3598 - "NetSlice instances"
3599 summary: Delete an individual NS instance resource
3600 description: Delete an individual NS instance resource
3601 operationId: deleteNSIContent
3604 description: Accepted
3608 $ref: '#/components/schemas/ObjectId'
3611 $ref: '#/components/schemas/ObjectId'
3613 description: No Content
3615 $ref: '#/components/responses/BadRequest'
3617 $ref: '#/components/responses/Unauthorized'
3619 $ref: '#/components/responses/Forbidden'
3621 $ref: '#/components/responses/NotFound'
3623 $ref: '#/components/responses/MethodNotAllowed'
3625 $ref: '#/components/responses/NotAcceptable'
3627 $ref: '#/components/responses/Conflict'
3629 $ref: '#/components/responses/UnprocessableEntity'
3631 $ref: '#/components/responses/InternalServerError'
3633 $ref: '#/components/responses/ServiceUnavailable'
3635 $ref: '#/components/responses/UnexpectedError'
3637 $ref: '#/components/responses/UnexpectedError'
3638 '/nsilcm/v1/nsi_lcm_op_occs':
3641 - "NetSlice instances"
3642 summary: Query information about multiple NetSlice LCM Operation Occurrences
3643 description: Query information about multiple NetSlice LCM Operation Occurrences
3644 operationId: getNsiLcmOpOccs
3651 $ref: '#/components/schemas/ArrayOfNsiLcmOpOcc'
3654 $ref: '#/components/schemas/ArrayOfNsiLcmOpOcc'
3656 $ref: '#/components/responses/BadRequest'
3658 $ref: '#/components/responses/Unauthorized'
3660 $ref: '#/components/responses/Forbidden'
3662 $ref: '#/components/responses/NotFound'
3664 $ref: '#/components/responses/MethodNotAllowed'
3666 $ref: '#/components/responses/NotAcceptable'
3668 $ref: '#/components/responses/Conflict'
3670 $ref: '#/components/responses/UnprocessableEntity'
3672 $ref: '#/components/responses/InternalServerError'
3674 $ref: '#/components/responses/ServiceUnavailable'
3676 $ref: '#/components/responses/UnexpectedError'
3678 $ref: '#/components/responses/UnexpectedError'
3679 '/nsilcm/v1/nsi_lcm_op_occs/{nsiLcmOpOccId}':
3681 - name: nsiLcmOpOccId
3684 description: NetSlice LCM Operation Occurrence ID
3689 - "NetSlice instances"
3690 summary: Query information about an individual NetSlice LCM Operation Occurrence
3691 description: Query information about an individual NetSlice LCM Operation Occurrence
3692 operationId: getNsiLcmOpOcc
3699 $ref: '#/components/schemas/NsiLcmOpOcc'
3702 $ref: '#/components/schemas/NsiLcmOpOcc'
3704 $ref: '#/components/responses/BadRequest'
3706 $ref: '#/components/responses/Unauthorized'
3708 $ref: '#/components/responses/Forbidden'
3710 $ref: '#/components/responses/NotFound'
3712 $ref: '#/components/responses/MethodNotAllowed'
3714 $ref: '#/components/responses/NotAcceptable'
3716 $ref: '#/components/responses/Conflict'
3718 $ref: '#/components/responses/UnprocessableEntity'
3720 $ref: '#/components/responses/InternalServerError'
3722 $ref: '#/components/responses/ServiceUnavailable'
3724 $ref: '#/components/responses/UnexpectedError'
3726 $ref: '#/components/responses/UnexpectedError'
3727 # END NetSlice Instances
3730 '/nspm/v1/pm_jobs/{pmJobId}/reports/{nsId}':
3735 description: NS PM Job ID
3746 - "NS Performance Management"
3747 summary: Query information about an individual NS PM Job Report
3748 description: Query information about an individual NS PM Job Report
3749 operationId: getNsPmJobReport
3756 $ref: '#/components/schemas/NsPmJobReportInfo'
3759 $ref: '#/components/schemas/NsPmJobReportInfo'
3761 $ref: '#/components/responses/BadRequest'
3763 $ref: '#/components/responses/Unauthorized'
3765 $ref: '#/components/responses/Forbidden'
3767 $ref: '#/components/responses/NotFound'
3769 $ref: '#/components/responses/MethodNotAllowed'
3771 $ref: '#/components/responses/NotAcceptable'
3773 $ref: '#/components/responses/Conflict'
3775 $ref: '#/components/responses/UnprocessableEntity'
3777 $ref: '#/components/responses/InternalServerError'
3779 $ref: '#/components/responses/ServiceUnavailable'
3781 $ref: '#/components/responses/UnexpectedError'
3783 $ref: '#/components/responses/UnexpectedError'
3787 '/pdu/v1/pdu_descriptors':
3790 - "Physical Data Units (PDU)"
3791 summary: Query information about multiple PDU Descriptors
3792 description: Query information about multiple PDU Descriptors
3793 operationId: getPDUs
3800 $ref: '#/components/schemas/ArrayOfPduInfo'
3803 $ref: '#/components/schemas/ArrayOfPduInfo'
3805 $ref: '#/components/responses/BadRequest'
3807 $ref: '#/components/responses/Unauthorized'
3809 $ref: '#/components/responses/Forbidden'
3811 $ref: '#/components/responses/NotFound'
3813 $ref: '#/components/responses/MethodNotAllowed'
3815 $ref: '#/components/responses/NotAcceptable'
3817 $ref: '#/components/responses/Conflict'
3819 $ref: '#/components/responses/UnprocessableEntity'
3821 $ref: '#/components/responses/InternalServerError'
3823 $ref: '#/components/responses/ServiceUnavailable'
3825 $ref: '#/components/responses/UnexpectedError'
3827 $ref: '#/components/responses/UnexpectedError'
3830 - "Physical Data Units (PDU)"
3831 summary: Create a new PDU
3832 description: Create a new PDU Descriptor
3833 operationId: createPDU
3835 $ref: '#/components/requestBodies/CreatePduRequest'
3847 $ref: '#/components/schemas/ObjectId'
3850 $ref: '#/components/schemas/ObjectId'
3852 $ref: '#/components/responses/BadRequest'
3854 $ref: '#/components/responses/Unauthorized'
3856 $ref: '#/components/responses/Forbidden'
3858 $ref: '#/components/responses/NotFound'
3860 $ref: '#/components/responses/MethodNotAllowed'
3862 $ref: '#/components/responses/NotAcceptable'
3864 $ref: '#/components/responses/Conflict'
3866 $ref: '#/components/responses/UnprocessableEntity'
3868 $ref: '#/components/responses/InternalServerError'
3870 $ref: '#/components/responses/ServiceUnavailable'
3872 $ref: '#/components/responses/UnexpectedError'
3874 $ref: '#/components/responses/UnexpectedError'
3875 '/pdu/v1/pdu_descriptors/{pduDescriptorId}':
3877 - name: pduDescriptorId
3880 description: PDU Descriptor ID
3885 - "Physical Data Units (PDU)"
3886 summary: Query information about an individual PDU Descriptor
3887 description: Query information about an individual PDU Descriptor
3895 $ref: '#/components/schemas/PduInfo'
3898 $ref: '#/components/schemas/PduInfo'
3900 $ref: '#/components/responses/BadRequest'
3902 $ref: '#/components/responses/Unauthorized'
3904 $ref: '#/components/responses/Forbidden'
3906 $ref: '#/components/responses/NotFound'
3908 $ref: '#/components/responses/MethodNotAllowed'
3910 $ref: '#/components/responses/NotAcceptable'
3912 $ref: '#/components/responses/Conflict'
3914 $ref: '#/components/responses/UnprocessableEntity'
3916 $ref: '#/components/responses/InternalServerError'
3918 $ref: '#/components/responses/ServiceUnavailable'
3920 $ref: '#/components/responses/UnexpectedError'
3922 $ref: '#/components/responses/UnexpectedError'
3925 - "Physical Data Units (PDU)"
3926 summary: Modify an individual PDU Descriptor
3927 description: Modify an individual PDU Descriptor
3928 operationId: editPDU
3930 $ref: '#/components/requestBodies/EditPduRequest'
3933 description: No Content
3935 $ref: '#/components/responses/BadRequest'
3937 $ref: '#/components/responses/Unauthorized'
3939 $ref: '#/components/responses/Forbidden'
3941 $ref: '#/components/responses/NotFound'
3943 $ref: '#/components/responses/MethodNotAllowed'
3945 $ref: '#/components/responses/NotAcceptable'
3947 $ref: '#/components/responses/Conflict'
3949 $ref: '#/components/responses/UnprocessableEntity'
3951 $ref: '#/components/responses/InternalServerError'
3953 $ref: '#/components/responses/ServiceUnavailable'
3955 $ref: '#/components/responses/UnexpectedError'
3957 $ref: '#/components/responses/UnexpectedError'
3960 - "Physical Data Units (PDU)"
3961 summary: Delete an individual PDU Descriptor
3962 description: Delete an individual PDU Descriptor
3963 operationId: deletePDU
3966 description: No Content
3968 $ref: '#/components/responses/BadRequest'
3970 $ref: '#/components/responses/Unauthorized'
3972 $ref: '#/components/responses/Forbidden'
3974 $ref: '#/components/responses/NotFound'
3976 $ref: '#/components/responses/MethodNotAllowed'
3978 $ref: '#/components/responses/NotAcceptable'
3980 $ref: '#/components/responses/Conflict'
3982 $ref: '#/components/responses/UnprocessableEntity'
3984 $ref: '#/components/responses/InternalServerError'
3986 $ref: '#/components/responses/ServiceUnavailable'
3988 $ref: '#/components/responses/UnexpectedError'
3990 $ref: '#/components/responses/UnexpectedError'
3999 summary: Query information about multiple Tokens
4000 description: Query information about multiple Tokens
4001 operationId: getTokens
4008 $ref: '#/components/schemas/ArrayOfTokenInfo'
4011 $ref: '#/components/schemas/ArrayOfTokenInfo'
4013 $ref: '#/components/responses/BadRequest'
4015 $ref: '#/components/responses/Unauthorized'
4017 $ref: '#/components/responses/Forbidden'
4019 $ref: '#/components/responses/NotFound'
4021 $ref: '#/components/responses/MethodNotAllowed'
4023 $ref: '#/components/responses/NotAcceptable'
4025 $ref: '#/components/responses/Conflict'
4027 $ref: '#/components/responses/UnprocessableEntity'
4029 $ref: '#/components/responses/InternalServerError'
4031 $ref: '#/components/responses/ServiceUnavailable'
4033 $ref: '#/components/responses/UnexpectedError'
4035 $ref: '#/components/responses/UnexpectedError'
4040 summary: Request a new Token
4041 description: Request a new Token
4042 operationId: createToken
4044 $ref: '#/components/requestBodies/CreateTokenRequest'
4057 - $ref: '#/components/schemas/TokenInfo'
4058 - $ref: '#/components/schemas/PasswordExpiryInfo'
4062 - $ref: '#/components/schemas/TokenInfo'
4063 - $ref: '#/components/schemas/PasswordExpiryInfo'
4065 $ref: '#/components/responses/BadRequest'
4067 $ref: '#/components/responses/Unauthorized'
4069 $ref: '#/components/responses/Forbidden'
4071 $ref: '#/components/responses/NotFound'
4073 $ref: '#/components/responses/MethodNotAllowed'
4075 $ref: '#/components/responses/NotAcceptable'
4077 $ref: '#/components/responses/Conflict'
4079 $ref: '#/components/responses/UnprocessableEntity'
4081 $ref: '#/components/responses/InternalServerError'
4083 $ref: '#/components/responses/ServiceUnavailable'
4085 $ref: '#/components/responses/UnexpectedError'
4087 $ref: '#/components/responses/UnexpectedError'
4092 summary: Delete the Token indicated in the Authorization Header
4093 description: Delete the Token indicated in the Authorization Header
4094 operationId: deleteAuthToken
4106 $ref: '#/components/responses/BadRequest'
4108 $ref: '#/components/responses/Unauthorized'
4110 $ref: '#/components/responses/Forbidden'
4112 $ref: '#/components/responses/NotFound'
4114 $ref: '#/components/responses/MethodNotAllowed'
4116 $ref: '#/components/responses/NotAcceptable'
4118 $ref: '#/components/responses/Conflict'
4120 $ref: '#/components/responses/UnprocessableEntity'
4122 $ref: '#/components/responses/InternalServerError'
4124 $ref: '#/components/responses/ServiceUnavailable'
4126 $ref: '#/components/responses/UnexpectedError'
4128 $ref: '#/components/responses/UnexpectedError'
4129 '/admin/v1/tokens/{tokenId}':
4134 description: Token ID
4141 summary: Query information about an individual Token
4142 description: Query information about an individual Token
4143 operationId: getToken
4150 $ref: '#/components/schemas/TokenInfo'
4153 $ref: '#/components/schemas/TokenInfo'
4155 $ref: '#/components/responses/BadRequest'
4157 $ref: '#/components/responses/Unauthorized'
4159 $ref: '#/components/responses/Forbidden'
4161 $ref: '#/components/responses/NotFound'
4163 $ref: '#/components/responses/MethodNotAllowed'
4165 $ref: '#/components/responses/NotAcceptable'
4167 $ref: '#/components/responses/Conflict'
4169 $ref: '#/components/responses/UnprocessableEntity'
4171 $ref: '#/components/responses/InternalServerError'
4173 $ref: '#/components/responses/ServiceUnavailable'
4175 $ref: '#/components/responses/UnexpectedError'
4177 $ref: '#/components/responses/UnexpectedError'
4182 summary: Delete the Token indicated as parameter
4183 description: Delete the Token indicated as parameter
4184 operationId: deleteToken
4196 $ref: '#/components/responses/BadRequest'
4198 $ref: '#/components/responses/Unauthorized'
4200 $ref: '#/components/responses/Forbidden'
4202 $ref: '#/components/responses/NotFound'
4204 $ref: '#/components/responses/MethodNotAllowed'
4206 $ref: '#/components/responses/NotAcceptable'
4208 $ref: '#/components/responses/Conflict'
4210 $ref: '#/components/responses/UnprocessableEntity'
4212 $ref: '#/components/responses/InternalServerError'
4214 $ref: '#/components/responses/ServiceUnavailable'
4216 $ref: '#/components/responses/UnexpectedError'
4218 $ref: '#/components/responses/UnexpectedError'
4224 summary: Query information about multiple Users
4225 description: Query information about multiple Users
4226 operationId: getUsers
4233 $ref: '#/components/schemas/ArrayOfUserInfo'
4236 $ref: '#/components/schemas/ArrayOfUserInfo'
4238 $ref: '#/components/responses/BadRequest'
4240 $ref: '#/components/responses/Unauthorized'
4242 $ref: '#/components/responses/Forbidden'
4244 $ref: '#/components/responses/NotFound'
4246 $ref: '#/components/responses/MethodNotAllowed'
4248 $ref: '#/components/responses/NotAcceptable'
4250 $ref: '#/components/responses/Conflict'
4252 $ref: '#/components/responses/UnprocessableEntity'
4254 $ref: '#/components/responses/InternalServerError'
4256 $ref: '#/components/responses/ServiceUnavailable'
4258 $ref: '#/components/responses/UnexpectedError'
4260 $ref: '#/components/responses/UnexpectedError'
4265 summary: Create a new User
4266 description: Create a new User
4267 operationId: createUser
4269 $ref: '#/components/requestBodies/CreateUserRequest'
4272 description: Created
4281 $ref: '#/components/schemas/ObjectId'
4284 $ref: '#/components/schemas/ObjectId'
4286 $ref: '#/components/responses/BadRequest'
4288 $ref: '#/components/responses/Unauthorized'
4290 $ref: '#/components/responses/Forbidden'
4292 $ref: '#/components/responses/NotFound'
4294 $ref: '#/components/responses/MethodNotAllowed'
4296 $ref: '#/components/responses/NotAcceptable'
4298 $ref: '#/components/responses/Conflict'
4300 $ref: '#/components/responses/UnprocessableEntity'
4302 $ref: '#/components/responses/InternalServerError'
4304 $ref: '#/components/responses/ServiceUnavailable'
4306 $ref: '#/components/responses/UnexpectedError'
4308 $ref: '#/components/responses/UnexpectedError'
4309 '/admin/v1/users/{userId}':
4314 description: User ID/Name
4321 summary: Query information about an individual User
4322 description: Query information about an individual User
4323 operationId: getUser
4330 $ref: '#/components/schemas/UserInfo'
4333 $ref: '#/components/schemas/UserInfo'
4335 $ref: '#/components/responses/BadRequest'
4337 $ref: '#/components/responses/Unauthorized'
4339 $ref: '#/components/responses/Forbidden'
4341 $ref: '#/components/responses/NotFound'
4343 $ref: '#/components/responses/MethodNotAllowed'
4345 $ref: '#/components/responses/NotAcceptable'
4347 $ref: '#/components/responses/Conflict'
4349 $ref: '#/components/responses/UnprocessableEntity'
4351 $ref: '#/components/responses/InternalServerError'
4353 $ref: '#/components/responses/ServiceUnavailable'
4355 $ref: '#/components/responses/UnexpectedError'
4357 $ref: '#/components/responses/UnexpectedError'
4362 summary: Modify a User
4363 description: Modify a User
4364 operationId: editUser
4366 $ref: '#/components/requestBodies/EditUserRequest'
4369 description: No Content
4371 $ref: '#/components/responses/BadRequest'
4373 $ref: '#/components/responses/Unauthorized'
4375 $ref: '#/components/responses/Forbidden'
4377 $ref: '#/components/responses/NotFound'
4379 $ref: '#/components/responses/MethodNotAllowed'
4381 $ref: '#/components/responses/NotAcceptable'
4383 $ref: '#/components/responses/Conflict'
4385 $ref: '#/components/responses/UnprocessableEntity'
4387 $ref: '#/components/responses/InternalServerError'
4389 $ref: '#/components/responses/ServiceUnavailable'
4391 $ref: '#/components/responses/UnexpectedError'
4393 $ref: '#/components/responses/UnexpectedError'
4398 summary: Delete a User
4399 description: Delete a User
4400 operationId: deleteUser
4403 description: No Content
4405 $ref: '#/components/responses/BadRequest'
4407 $ref: '#/components/responses/Unauthorized'
4409 $ref: '#/components/responses/Forbidden'
4411 $ref: '#/components/responses/NotFound'
4413 $ref: '#/components/responses/MethodNotAllowed'
4415 $ref: '#/components/responses/NotAcceptable'
4417 $ref: '#/components/responses/Conflict'
4419 $ref: '#/components/responses/UnprocessableEntity'
4421 $ref: '#/components/responses/InternalServerError'
4423 $ref: '#/components/responses/ServiceUnavailable'
4425 $ref: '#/components/responses/UnexpectedError'
4427 $ref: '#/components/responses/UnexpectedError'
4428 '/admin/v1/projects':
4433 summary: Query information about multiple Projects
4434 description: Query information about multiple Projects
4435 operationId: getProjects
4442 $ref: '#/components/schemas/ArrayOfProjectInfo'
4445 $ref: '#/components/schemas/ArrayOfProjectInfo'
4447 $ref: '#/components/responses/BadRequest'
4449 $ref: '#/components/responses/Unauthorized'
4451 $ref: '#/components/responses/Forbidden'
4453 $ref: '#/components/responses/NotFound'
4455 $ref: '#/components/responses/MethodNotAllowed'
4457 $ref: '#/components/responses/NotAcceptable'
4459 $ref: '#/components/responses/Conflict'
4461 $ref: '#/components/responses/UnprocessableEntity'
4463 $ref: '#/components/responses/InternalServerError'
4465 $ref: '#/components/responses/ServiceUnavailable'
4467 $ref: '#/components/responses/UnexpectedError'
4469 $ref: '#/components/responses/UnexpectedError'
4474 summary: Create a new Project
4475 description: Create a new Project
4476 operationId: createProject
4478 $ref: '#/components/requestBodies/CreateProjectRequest'
4481 description: Created
4490 $ref: '#/components/schemas/ObjectId'
4493 $ref: '#/components/schemas/ObjectId'
4495 $ref: '#/components/responses/BadRequest'
4497 $ref: '#/components/responses/Unauthorized'
4499 $ref: '#/components/responses/Forbidden'
4501 $ref: '#/components/responses/NotFound'
4503 $ref: '#/components/responses/MethodNotAllowed'
4505 $ref: '#/components/responses/NotAcceptable'
4507 $ref: '#/components/responses/Conflict'
4509 $ref: '#/components/responses/UnprocessableEntity'
4511 $ref: '#/components/responses/InternalServerError'
4513 $ref: '#/components/responses/ServiceUnavailable'
4515 $ref: '#/components/responses/UnexpectedError'
4517 $ref: '#/components/responses/UnexpectedError'
4518 '/admin/v1/projects/{projectId}':
4523 description: Project ID/Name
4530 summary: Query information about an individual Project
4531 description: Query information about an individual Project
4532 operationId: getProject
4539 $ref: '#/components/schemas/ProjectInfo'
4542 $ref: '#/components/schemas/ProjectInfo'
4544 $ref: '#/components/responses/BadRequest'
4546 $ref: '#/components/responses/Unauthorized'
4548 $ref: '#/components/responses/Forbidden'
4550 $ref: '#/components/responses/NotFound'
4552 $ref: '#/components/responses/MethodNotAllowed'
4554 $ref: '#/components/responses/NotAcceptable'
4556 $ref: '#/components/responses/Conflict'
4558 $ref: '#/components/responses/UnprocessableEntity'
4560 $ref: '#/components/responses/InternalServerError'
4562 $ref: '#/components/responses/ServiceUnavailable'
4564 $ref: '#/components/responses/UnexpectedError'
4566 $ref: '#/components/responses/UnexpectedError'
4571 summary: Modify a Project
4572 description: Modify a Project
4573 operationId: editProject
4575 $ref: '#/components/requestBodies/EditProjectRequest'
4578 description: No Content
4580 $ref: '#/components/responses/BadRequest'
4582 $ref: '#/components/responses/Unauthorized'
4584 $ref: '#/components/responses/Forbidden'
4586 $ref: '#/components/responses/NotFound'
4588 $ref: '#/components/responses/MethodNotAllowed'
4590 $ref: '#/components/responses/NotAcceptable'
4592 $ref: '#/components/responses/Conflict'
4594 $ref: '#/components/responses/UnprocessableEntity'
4596 $ref: '#/components/responses/InternalServerError'
4598 $ref: '#/components/responses/ServiceUnavailable'
4600 $ref: '#/components/responses/UnexpectedError'
4602 $ref: '#/components/responses/UnexpectedError'
4607 summary: Delete a Project
4608 description: Delete a Project
4609 operationId: deleteProject
4612 description: No Content
4614 $ref: '#/components/responses/BadRequest'
4616 $ref: '#/components/responses/Unauthorized'
4618 $ref: '#/components/responses/Forbidden'
4620 $ref: '#/components/responses/NotFound'
4622 $ref: '#/components/responses/MethodNotAllowed'
4624 $ref: '#/components/responses/NotAcceptable'
4626 $ref: '#/components/responses/Conflict'
4628 $ref: '#/components/responses/UnprocessableEntity'
4630 $ref: '#/components/responses/InternalServerError'
4632 $ref: '#/components/responses/ServiceUnavailable'
4634 $ref: '#/components/responses/UnexpectedError'
4636 $ref: '#/components/responses/UnexpectedError'
4642 summary: Query information about multiple Roles
4643 description: Query information about multiple Roles
4644 operationId: getRoles
4651 $ref: '#/components/schemas/ArrayOfRoleInfo'
4654 $ref: '#/components/schemas/ArrayOfRoleInfo'
4656 $ref: '#/components/responses/BadRequest'
4658 $ref: '#/components/responses/Unauthorized'
4660 $ref: '#/components/responses/Forbidden'
4662 $ref: '#/components/responses/NotFound'
4664 $ref: '#/components/responses/MethodNotAllowed'
4666 $ref: '#/components/responses/NotAcceptable'
4668 $ref: '#/components/responses/Conflict'
4670 $ref: '#/components/responses/UnprocessableEntity'
4672 $ref: '#/components/responses/InternalServerError'
4674 $ref: '#/components/responses/ServiceUnavailable'
4676 $ref: '#/components/responses/UnexpectedError'
4678 $ref: '#/components/responses/UnexpectedError'
4683 summary: Create a new Role
4684 description: Create a new Role
4685 operationId: createRole
4687 $ref: '#/components/requestBodies/CreateRoleRequest'
4690 description: Created
4699 $ref: '#/components/schemas/ObjectId'
4702 $ref: '#/components/schemas/ObjectId'
4704 $ref: '#/components/responses/BadRequest'
4706 $ref: '#/components/responses/Unauthorized'
4708 $ref: '#/components/responses/Forbidden'
4710 $ref: '#/components/responses/NotFound'
4712 $ref: '#/components/responses/MethodNotAllowed'
4714 $ref: '#/components/responses/NotAcceptable'
4716 $ref: '#/components/responses/Conflict'
4718 $ref: '#/components/responses/UnprocessableEntity'
4720 $ref: '#/components/responses/InternalServerError'
4722 $ref: '#/components/responses/ServiceUnavailable'
4724 $ref: '#/components/responses/UnexpectedError'
4726 $ref: '#/components/responses/UnexpectedError'
4727 '/admin/v1/roles/{roleId}':
4732 description: Role ID/Name
4739 summary: Query information about an individual Role
4740 description: Query information about an individual Role
4741 operationId: getRole
4748 $ref: '#/components/schemas/RoleInfo'
4751 $ref: '#/components/schemas/RoleInfo'
4753 $ref: '#/components/responses/BadRequest'
4755 $ref: '#/components/responses/Unauthorized'
4757 $ref: '#/components/responses/Forbidden'
4759 $ref: '#/components/responses/NotFound'
4761 $ref: '#/components/responses/MethodNotAllowed'
4763 $ref: '#/components/responses/NotAcceptable'
4765 $ref: '#/components/responses/Conflict'
4767 $ref: '#/components/responses/UnprocessableEntity'
4769 $ref: '#/components/responses/InternalServerError'
4771 $ref: '#/components/responses/ServiceUnavailable'
4773 $ref: '#/components/responses/UnexpectedError'
4775 $ref: '#/components/responses/UnexpectedError'
4780 summary: Modify a Role
4781 description: Modify a Role
4782 operationId: editRole
4784 $ref: '#/components/requestBodies/EditRoleRequest'
4787 description: No Content
4789 $ref: '#/components/responses/BadRequest'
4791 $ref: '#/components/responses/Unauthorized'
4793 $ref: '#/components/responses/Forbidden'
4795 $ref: '#/components/responses/NotFound'
4797 $ref: '#/components/responses/MethodNotAllowed'
4799 $ref: '#/components/responses/NotAcceptable'
4801 $ref: '#/components/responses/Conflict'
4803 $ref: '#/components/responses/UnprocessableEntity'
4805 $ref: '#/components/responses/InternalServerError'
4807 $ref: '#/components/responses/ServiceUnavailable'
4809 $ref: '#/components/responses/UnexpectedError'
4811 $ref: '#/components/responses/UnexpectedError'
4816 summary: Delete a Role
4817 description: Delete a Role
4818 operationId: deleteRole
4821 description: No Content
4823 $ref: '#/components/responses/BadRequest'
4825 $ref: '#/components/responses/Unauthorized'
4827 $ref: '#/components/responses/Forbidden'
4829 $ref: '#/components/responses/NotFound'
4831 $ref: '#/components/responses/MethodNotAllowed'
4833 $ref: '#/components/responses/NotAcceptable'
4835 $ref: '#/components/responses/Conflict'
4837 $ref: '#/components/responses/UnprocessableEntity'
4839 $ref: '#/components/responses/InternalServerError'
4841 $ref: '#/components/responses/ServiceUnavailable'
4843 $ref: '#/components/responses/UnexpectedError'
4845 $ref: '#/components/responses/UnexpectedError'
4851 summary: Query information about multiple VIMs
4852 description: Query information about multiple VIMs
4853 operationId: getVIMs
4860 $ref: '#/components/schemas/ArrayOfVimInfo'
4863 $ref: '#/components/schemas/ArrayOfVimInfo'
4865 $ref: '#/components/responses/BadRequest'
4867 $ref: '#/components/responses/Unauthorized'
4869 $ref: '#/components/responses/Forbidden'
4871 $ref: '#/components/responses/NotFound'
4873 $ref: '#/components/responses/MethodNotAllowed'
4875 $ref: '#/components/responses/NotAcceptable'
4877 $ref: '#/components/responses/Conflict'
4879 $ref: '#/components/responses/UnprocessableEntity'
4881 $ref: '#/components/responses/InternalServerError'
4883 $ref: '#/components/responses/ServiceUnavailable'
4885 $ref: '#/components/responses/UnexpectedError'
4887 $ref: '#/components/responses/UnexpectedError'
4892 summary: Create a new VIM
4893 description: Create a new VIM
4894 operationId: createVIM
4896 $ref: '#/components/requestBodies/CreateVimRequest'
4899 description: Accepted
4903 $ref: '#/components/schemas/ObjectId_plus_OpId'
4906 $ref: '#/components/schemas/ObjectId_plus_OpId'
4908 $ref: '#/components/responses/BadRequest'
4910 $ref: '#/components/responses/Unauthorized'
4912 $ref: '#/components/responses/Forbidden'
4914 $ref: '#/components/responses/NotFound'
4916 $ref: '#/components/responses/MethodNotAllowed'
4918 $ref: '#/components/responses/NotAcceptable'
4920 $ref: '#/components/responses/Conflict'
4922 $ref: '#/components/responses/UnprocessableEntity'
4924 $ref: '#/components/responses/InternalServerError'
4926 $ref: '#/components/responses/ServiceUnavailable'
4928 $ref: '#/components/responses/UnexpectedError'
4930 $ref: '#/components/responses/UnexpectedError'
4931 '/admin/v1/vims/{vimId}':
4944 summary: Query information about an individual VIM
4945 description: Query information about an individual VIM
4953 $ref: '#/components/schemas/VimInfo'
4956 $ref: '#/components/schemas/VimInfo'
4958 $ref: '#/components/responses/BadRequest'
4960 $ref: '#/components/responses/Unauthorized'
4962 $ref: '#/components/responses/Forbidden'
4964 $ref: '#/components/responses/NotFound'
4966 $ref: '#/components/responses/MethodNotAllowed'
4968 $ref: '#/components/responses/NotAcceptable'
4970 $ref: '#/components/responses/Conflict'
4972 $ref: '#/components/responses/UnprocessableEntity'
4974 $ref: '#/components/responses/InternalServerError'
4976 $ref: '#/components/responses/ServiceUnavailable'
4978 $ref: '#/components/responses/UnexpectedError'
4980 $ref: '#/components/responses/UnexpectedError'
4985 summary: Modify a VIM
4986 description: Modify a VIM
4987 operationId: editVIM
4989 $ref: '#/components/requestBodies/EditVimRequest'
4992 description: Accepted
4996 $ref: '#/components/schemas/OpId'
4999 $ref: '#/components/schemas/OpId'
5001 $ref: '#/components/responses/BadRequest'
5003 $ref: '#/components/responses/Unauthorized'
5005 $ref: '#/components/responses/Forbidden'
5007 $ref: '#/components/responses/NotFound'
5009 $ref: '#/components/responses/MethodNotAllowed'
5011 $ref: '#/components/responses/NotAcceptable'
5013 $ref: '#/components/responses/Conflict'
5015 $ref: '#/components/responses/UnprocessableEntity'
5017 $ref: '#/components/responses/InternalServerError'
5019 $ref: '#/components/responses/ServiceUnavailable'
5021 $ref: '#/components/responses/UnexpectedError'
5023 $ref: '#/components/responses/UnexpectedError'
5028 summary: Delete a VIM
5029 description: Delete a VIM
5030 operationId: deleteVIM
5033 description: Accepted
5035 $ref: '#/components/responses/BadRequest'
5037 $ref: '#/components/responses/Unauthorized'
5039 $ref: '#/components/responses/Forbidden'
5041 $ref: '#/components/responses/NotFound'
5043 $ref: '#/components/responses/MethodNotAllowed'
5045 $ref: '#/components/responses/NotAcceptable'
5047 $ref: '#/components/responses/Conflict'
5049 $ref: '#/components/responses/UnprocessableEntity'
5051 $ref: '#/components/responses/InternalServerError'
5053 $ref: '#/components/responses/ServiceUnavailable'
5055 $ref: '#/components/responses/UnexpectedError'
5057 $ref: '#/components/responses/UnexpectedError'
5058 '/admin/v1/vim_accounts':
5063 summary: Query information about multiple VIM Accounts
5064 description: Query information about multiple VIM Accounts
5065 operationId: getVimAccounts
5072 $ref: '#/components/schemas/ArrayOfVimInfo'
5075 $ref: '#/components/schemas/ArrayOfVimInfo'
5077 $ref: '#/components/responses/BadRequest'
5079 $ref: '#/components/responses/Unauthorized'
5081 $ref: '#/components/responses/Forbidden'
5083 $ref: '#/components/responses/NotFound'
5085 $ref: '#/components/responses/MethodNotAllowed'
5087 $ref: '#/components/responses/NotAcceptable'
5089 $ref: '#/components/responses/Conflict'
5091 $ref: '#/components/responses/UnprocessableEntity'
5093 $ref: '#/components/responses/InternalServerError'
5095 $ref: '#/components/responses/ServiceUnavailable'
5097 $ref: '#/components/responses/UnexpectedError'
5099 $ref: '#/components/responses/UnexpectedError'
5104 summary: Create a new VIM Account
5105 description: Create a new VIM Account
5106 operationId: createVimAccount
5108 $ref: '#/components/requestBodies/CreateVimRequest'
5111 description: Accepted
5115 $ref: '#/components/schemas/ObjectId_plus_OpId'
5118 $ref: '#/components/schemas/ObjectId_plus_OpId'
5120 $ref: '#/components/responses/BadRequest'
5122 $ref: '#/components/responses/Unauthorized'
5124 $ref: '#/components/responses/Forbidden'
5126 $ref: '#/components/responses/NotFound'
5128 $ref: '#/components/responses/MethodNotAllowed'
5130 $ref: '#/components/responses/NotAcceptable'
5132 $ref: '#/components/responses/Conflict'
5134 $ref: '#/components/responses/UnprocessableEntity'
5136 $ref: '#/components/responses/InternalServerError'
5138 $ref: '#/components/responses/ServiceUnavailable'
5140 $ref: '#/components/responses/UnexpectedError'
5142 $ref: '#/components/responses/UnexpectedError'
5143 '/admin/v1/vim_accounts/{vimAccountId}':
5145 - name: vimAccountId
5148 description: VIM Account ID
5156 summary: Query information about an individual VIM Account
5157 description: Query information about an individual VIM Account
5158 operationId: getVimAccount
5165 $ref: '#/components/schemas/VimInfo'
5168 $ref: '#/components/schemas/VimInfo'
5170 $ref: '#/components/responses/BadRequest'
5172 $ref: '#/components/responses/Unauthorized'
5174 $ref: '#/components/responses/Forbidden'
5176 $ref: '#/components/responses/NotFound'
5178 $ref: '#/components/responses/MethodNotAllowed'
5180 $ref: '#/components/responses/NotAcceptable'
5182 $ref: '#/components/responses/Conflict'
5184 $ref: '#/components/responses/UnprocessableEntity'
5186 $ref: '#/components/responses/InternalServerError'
5188 $ref: '#/components/responses/ServiceUnavailable'
5190 $ref: '#/components/responses/UnexpectedError'
5192 $ref: '#/components/responses/UnexpectedError'
5197 summary: Modify a VIM Account
5198 description: Modify a VIM Account
5199 operationId: editVimAccount
5201 $ref: '#/components/requestBodies/EditVimRequest'
5204 description: Accepted
5208 $ref: '#/components/schemas/OpId'
5211 $ref: '#/components/schemas/OpId'
5213 $ref: '#/components/responses/BadRequest'
5215 $ref: '#/components/responses/Unauthorized'
5217 $ref: '#/components/responses/Forbidden'
5219 $ref: '#/components/responses/NotFound'
5221 $ref: '#/components/responses/MethodNotAllowed'
5223 $ref: '#/components/responses/NotAcceptable'
5225 $ref: '#/components/responses/Conflict'
5227 $ref: '#/components/responses/UnprocessableEntity'
5229 $ref: '#/components/responses/InternalServerError'
5231 $ref: '#/components/responses/ServiceUnavailable'
5233 $ref: '#/components/responses/UnexpectedError'
5235 $ref: '#/components/responses/UnexpectedError'
5240 summary: Delete a VIM Account
5241 description: Delete a VIM Account
5242 operationId: deleteVimAccount
5245 description: Accepted
5247 $ref: '#/components/responses/BadRequest'
5249 $ref: '#/components/responses/Unauthorized'
5251 $ref: '#/components/responses/Forbidden'
5253 $ref: '#/components/responses/NotFound'
5255 $ref: '#/components/responses/MethodNotAllowed'
5257 $ref: '#/components/responses/NotAcceptable'
5259 $ref: '#/components/responses/Conflict'
5261 $ref: '#/components/responses/UnprocessableEntity'
5263 $ref: '#/components/responses/InternalServerError'
5265 $ref: '#/components/responses/ServiceUnavailable'
5267 $ref: '#/components/responses/UnexpectedError'
5269 $ref: '#/components/responses/UnexpectedError'
5270 '/admin/v1/wim_accounts':
5275 summary: Query information about multiple WIM Accounts
5276 description: Query information about multiple WIM Accounts
5277 operationId: getWimAccounts
5284 $ref: '#/components/schemas/ArrayOfWimInfo'
5287 $ref: '#/components/schemas/ArrayOfWimInfo'
5289 $ref: '#/components/responses/BadRequest'
5291 $ref: '#/components/responses/Unauthorized'
5293 $ref: '#/components/responses/Forbidden'
5295 $ref: '#/components/responses/NotFound'
5297 $ref: '#/components/responses/MethodNotAllowed'
5299 $ref: '#/components/responses/NotAcceptable'
5301 $ref: '#/components/responses/Conflict'
5303 $ref: '#/components/responses/UnprocessableEntity'
5305 $ref: '#/components/responses/InternalServerError'
5307 $ref: '#/components/responses/ServiceUnavailable'
5309 $ref: '#/components/responses/UnexpectedError'
5311 $ref: '#/components/responses/UnexpectedError'
5316 summary: Create a new WIM Account
5317 description: Create a new WIM Account
5318 operationId: createWimAccount
5320 $ref: '#/components/requestBodies/CreateWimRequest'
5323 description: Accepted
5327 $ref: '#/components/schemas/ObjectId_plus_OpId'
5330 $ref: '#/components/schemas/ObjectId_plus_OpId'
5332 $ref: '#/components/responses/BadRequest'
5334 $ref: '#/components/responses/Unauthorized'
5336 $ref: '#/components/responses/Forbidden'
5338 $ref: '#/components/responses/NotFound'
5340 $ref: '#/components/responses/MethodNotAllowed'
5342 $ref: '#/components/responses/NotAcceptable'
5344 $ref: '#/components/responses/Conflict'
5346 $ref: '#/components/responses/UnprocessableEntity'
5348 $ref: '#/components/responses/InternalServerError'
5350 $ref: '#/components/responses/ServiceUnavailable'
5352 $ref: '#/components/responses/UnexpectedError'
5354 $ref: '#/components/responses/UnexpectedError'
5355 '/admin/v1/wim_accounts/{wimAccountId}':
5357 - name: wimAccountId
5360 description: WIM Account ID
5368 summary: Query information about an individual WIM Account
5369 description: Query information about an individual WIM Account
5370 operationId: getWimAccount
5377 $ref: '#/components/schemas/WimInfo'
5380 $ref: '#/components/schemas/WimInfo'
5382 $ref: '#/components/responses/BadRequest'
5384 $ref: '#/components/responses/Unauthorized'
5386 $ref: '#/components/responses/Forbidden'
5388 $ref: '#/components/responses/NotFound'
5390 $ref: '#/components/responses/MethodNotAllowed'
5392 $ref: '#/components/responses/NotAcceptable'
5394 $ref: '#/components/responses/Conflict'
5396 $ref: '#/components/responses/UnprocessableEntity'
5398 $ref: '#/components/responses/InternalServerError'
5400 $ref: '#/components/responses/ServiceUnavailable'
5402 $ref: '#/components/responses/UnexpectedError'
5404 $ref: '#/components/responses/UnexpectedError'
5409 summary: Modify a WIM Account
5410 description: Modify a WIM Account
5411 operationId: editWimAccount
5413 $ref: '#/components/requestBodies/EditWimRequest'
5416 description: Accepted
5420 $ref: '#/components/schemas/OpId'
5423 $ref: '#/components/schemas/OpId'
5425 $ref: '#/components/responses/BadRequest'
5427 $ref: '#/components/responses/Unauthorized'
5429 $ref: '#/components/responses/Forbidden'
5431 $ref: '#/components/responses/NotFound'
5433 $ref: '#/components/responses/MethodNotAllowed'
5435 $ref: '#/components/responses/NotAcceptable'
5437 $ref: '#/components/responses/Conflict'
5439 $ref: '#/components/responses/UnprocessableEntity'
5441 $ref: '#/components/responses/InternalServerError'
5443 $ref: '#/components/responses/ServiceUnavailable'
5445 $ref: '#/components/responses/UnexpectedError'
5447 $ref: '#/components/responses/UnexpectedError'
5452 summary: Delete a WIM Account
5453 description: Delete a WIM Account
5454 operationId: deleteWimAccount
5457 description: Accepted
5459 $ref: '#/components/responses/BadRequest'
5461 $ref: '#/components/responses/Unauthorized'
5463 $ref: '#/components/responses/Forbidden'
5465 $ref: '#/components/responses/NotFound'
5467 $ref: '#/components/responses/MethodNotAllowed'
5469 $ref: '#/components/responses/NotAcceptable'
5471 $ref: '#/components/responses/Conflict'
5473 $ref: '#/components/responses/UnprocessableEntity'
5475 $ref: '#/components/responses/InternalServerError'
5477 $ref: '#/components/responses/ServiceUnavailable'
5479 $ref: '#/components/responses/UnexpectedError'
5481 $ref: '#/components/responses/UnexpectedError'
5487 summary: Query information about multiple SDNs
5488 description: Query information about multiple SDNs
5489 operationId: getSDNs
5496 $ref: '#/components/schemas/ArrayOfSdnInfo'
5499 $ref: '#/components/schemas/ArrayOfSdnInfo'
5501 $ref: '#/components/responses/BadRequest'
5503 $ref: '#/components/responses/Unauthorized'
5505 $ref: '#/components/responses/Forbidden'
5507 $ref: '#/components/responses/NotFound'
5509 $ref: '#/components/responses/MethodNotAllowed'
5511 $ref: '#/components/responses/NotAcceptable'
5513 $ref: '#/components/responses/Conflict'
5515 $ref: '#/components/responses/UnprocessableEntity'
5517 $ref: '#/components/responses/InternalServerError'
5519 $ref: '#/components/responses/ServiceUnavailable'
5521 $ref: '#/components/responses/UnexpectedError'
5523 $ref: '#/components/responses/UnexpectedError'
5528 summary: Create a new SDN
5529 description: Create a new SDN
5530 operationId: createSDN
5532 $ref: '#/components/requestBodies/CreateSdnRequest'
5535 description: Accepted
5539 $ref: '#/components/schemas/ObjectId_plus_OpId'
5542 $ref: '#/components/schemas/ObjectId_plus_OpId'
5544 $ref: '#/components/responses/BadRequest'
5546 $ref: '#/components/responses/Unauthorized'
5548 $ref: '#/components/responses/Forbidden'
5550 $ref: '#/components/responses/NotFound'
5552 $ref: '#/components/responses/MethodNotAllowed'
5554 $ref: '#/components/responses/NotAcceptable'
5556 $ref: '#/components/responses/Conflict'
5558 $ref: '#/components/responses/UnprocessableEntity'
5560 $ref: '#/components/responses/InternalServerError'
5562 $ref: '#/components/responses/ServiceUnavailable'
5564 $ref: '#/components/responses/UnexpectedError'
5566 $ref: '#/components/responses/UnexpectedError'
5567 '/admin/v1/sdns/{sdnId}':
5580 summary: Query information about an individual SDN
5581 description: Query information about an individual SDN
5589 $ref: '#/components/schemas/SdnInfo'
5592 $ref: '#/components/schemas/SdnInfo'
5594 $ref: '#/components/responses/BadRequest'
5596 $ref: '#/components/responses/Unauthorized'
5598 $ref: '#/components/responses/Forbidden'
5600 $ref: '#/components/responses/NotFound'
5602 $ref: '#/components/responses/MethodNotAllowed'
5604 $ref: '#/components/responses/NotAcceptable'
5606 $ref: '#/components/responses/Conflict'
5608 $ref: '#/components/responses/UnprocessableEntity'
5610 $ref: '#/components/responses/InternalServerError'
5612 $ref: '#/components/responses/ServiceUnavailable'
5614 $ref: '#/components/responses/UnexpectedError'
5616 $ref: '#/components/responses/UnexpectedError'
5621 summary: Modify a SDN
5622 description: Modify a SDN
5623 operationId: editSDN
5625 $ref: '#/components/requestBodies/EditSdnRequest'
5628 description: Accepted
5632 $ref: '#/components/schemas/OpId'
5635 $ref: '#/components/schemas/OpId'
5637 $ref: '#/components/responses/BadRequest'
5639 $ref: '#/components/responses/Unauthorized'
5641 $ref: '#/components/responses/Forbidden'
5643 $ref: '#/components/responses/NotFound'
5645 $ref: '#/components/responses/MethodNotAllowed'
5647 $ref: '#/components/responses/NotAcceptable'
5649 $ref: '#/components/responses/Conflict'
5651 $ref: '#/components/responses/UnprocessableEntity'
5653 $ref: '#/components/responses/InternalServerError'
5655 $ref: '#/components/responses/ServiceUnavailable'
5657 $ref: '#/components/responses/UnexpectedError'
5659 $ref: '#/components/responses/UnexpectedError'
5664 summary: Delete a SDN
5665 description: Delete a SDN
5666 operationId: deleteSDN
5669 description: Accepted
5671 $ref: '#/components/responses/BadRequest'
5673 $ref: '#/components/responses/Unauthorized'
5675 $ref: '#/components/responses/Forbidden'
5677 $ref: '#/components/responses/NotFound'
5679 $ref: '#/components/responses/MethodNotAllowed'
5681 $ref: '#/components/responses/NotAcceptable'
5683 $ref: '#/components/responses/Conflict'
5685 $ref: '#/components/responses/UnprocessableEntity'
5687 $ref: '#/components/responses/InternalServerError'
5689 $ref: '#/components/responses/ServiceUnavailable'
5691 $ref: '#/components/responses/UnexpectedError'
5693 $ref: '#/components/responses/UnexpectedError'
5694 '/admin/v1/k8sclusters':
5699 summary: Query information about multiple K8s Clusters
5700 description: Query information about multiple K8s Clusters
5701 operationId: getK8sClusters
5708 $ref: '#/components/schemas/ArrayOfK8sClusterInfo'
5711 $ref: '#/components/schemas/ArrayOfK8sClusterInfo'
5713 $ref: '#/components/responses/BadRequest'
5715 $ref: '#/components/responses/Unauthorized'
5717 $ref: '#/components/responses/Forbidden'
5719 $ref: '#/components/responses/NotFound'
5721 $ref: '#/components/responses/MethodNotAllowed'
5723 $ref: '#/components/responses/NotAcceptable'
5725 $ref: '#/components/responses/Conflict'
5727 $ref: '#/components/responses/UnprocessableEntity'
5729 $ref: '#/components/responses/InternalServerError'
5731 $ref: '#/components/responses/ServiceUnavailable'
5733 $ref: '#/components/responses/UnexpectedError'
5735 $ref: '#/components/responses/UnexpectedError'
5740 summary: Create a new K8s Cluster
5741 description: Create a new K8s Cluster
5742 operationId: createK8sCluster
5744 $ref: '#/components/requestBodies/CreateK8sClusterRequest'
5747 description: Accepted
5751 $ref: '#/components/schemas/ObjectId_plus_OpId'
5754 $ref: '#/components/schemas/ObjectId_plus_OpId'
5756 $ref: '#/components/responses/BadRequest'
5758 $ref: '#/components/responses/Unauthorized'
5760 $ref: '#/components/responses/Forbidden'
5762 $ref: '#/components/responses/NotFound'
5764 $ref: '#/components/responses/MethodNotAllowed'
5766 $ref: '#/components/responses/NotAcceptable'
5768 $ref: '#/components/responses/Conflict'
5770 $ref: '#/components/responses/UnprocessableEntity'
5772 $ref: '#/components/responses/InternalServerError'
5774 $ref: '#/components/responses/ServiceUnavailable'
5776 $ref: '#/components/responses/UnexpectedError'
5778 $ref: '#/components/responses/UnexpectedError'
5779 '/admin/v1/k8sclusters/{k8sClusterId}':
5781 - name: k8sClusterId
5784 description: K8s Cluster ID
5792 summary: Query information about an individual K8s Cluster
5793 description: Query information about an individual K8s Cluster
5794 operationId: getK8sCluster
5801 $ref: '#/components/schemas/K8sClusterInfo'
5804 $ref: '#/components/schemas/K8sClusterInfo'
5806 $ref: '#/components/responses/BadRequest'
5808 $ref: '#/components/responses/Unauthorized'
5810 $ref: '#/components/responses/Forbidden'
5812 $ref: '#/components/responses/NotFound'
5814 $ref: '#/components/responses/MethodNotAllowed'
5816 $ref: '#/components/responses/NotAcceptable'
5818 $ref: '#/components/responses/Conflict'
5820 $ref: '#/components/responses/UnprocessableEntity'
5822 $ref: '#/components/responses/InternalServerError'
5824 $ref: '#/components/responses/ServiceUnavailable'
5826 $ref: '#/components/responses/UnexpectedError'
5828 $ref: '#/components/responses/UnexpectedError'
5833 summary: Modify a K8s Cluster
5834 description: Modify a K8s Cluster
5835 operationId: editK8sCluster
5837 $ref: '#/components/requestBodies/EditK8sClusterRequest'
5840 description: Accepted
5844 $ref: '#/components/schemas/OpId'
5847 $ref: '#/components/schemas/OpId'
5849 $ref: '#/components/responses/BadRequest'
5851 $ref: '#/components/responses/Unauthorized'
5853 $ref: '#/components/responses/Forbidden'
5855 $ref: '#/components/responses/NotFound'
5857 $ref: '#/components/responses/MethodNotAllowed'
5859 $ref: '#/components/responses/NotAcceptable'
5861 $ref: '#/components/responses/Conflict'
5863 $ref: '#/components/responses/UnprocessableEntity'
5865 $ref: '#/components/responses/InternalServerError'
5867 $ref: '#/components/responses/ServiceUnavailable'
5869 $ref: '#/components/responses/UnexpectedError'
5871 $ref: '#/components/responses/UnexpectedError'
5876 summary: Delete a K8s Cluster
5877 description: Delete a K8s Cluster
5878 operationId: deleteK8sCluster
5881 description: Accepted
5883 $ref: '#/components/responses/BadRequest'
5885 $ref: '#/components/responses/Unauthorized'
5887 $ref: '#/components/responses/Forbidden'
5889 $ref: '#/components/responses/NotFound'
5891 $ref: '#/components/responses/MethodNotAllowed'
5893 $ref: '#/components/responses/NotAcceptable'
5895 $ref: '#/components/responses/Conflict'
5897 $ref: '#/components/responses/UnprocessableEntity'
5899 $ref: '#/components/responses/InternalServerError'
5901 $ref: '#/components/responses/ServiceUnavailable'
5903 $ref: '#/components/responses/UnexpectedError'
5905 $ref: '#/components/responses/UnexpectedError'
5911 summary: Query information about multiple VCAs
5912 description: Query information about multiple VCAs
5913 operationId: getVcas
5920 $ref: '#/components/schemas/ArrayOfVcaInfo'
5923 $ref: '#/components/schemas/ArrayOfVcaInfo'
5925 $ref: '#/components/responses/BadRequest'
5927 $ref: '#/components/responses/Unauthorized'
5929 $ref: '#/components/responses/Forbidden'
5931 $ref: '#/components/responses/NotFound'
5933 $ref: '#/components/responses/MethodNotAllowed'
5935 $ref: '#/components/responses/NotAcceptable'
5937 $ref: '#/components/responses/Conflict'
5939 $ref: '#/components/responses/UnprocessableEntity'
5941 $ref: '#/components/responses/InternalServerError'
5943 $ref: '#/components/responses/ServiceUnavailable'
5945 $ref: '#/components/responses/UnexpectedError'
5947 $ref: '#/components/responses/UnexpectedError'
5952 summary: Create a new VCA
5953 description: Create a new VCA
5954 operationId: createVca
5956 $ref: '#/components/requestBodies/CreateVcaRequest'
5959 description: Accepted
5963 $ref: '#/components/schemas/ObjectId_plus_OpId'
5966 $ref: '#/components/schemas/ObjectId_plus_OpId'
5968 $ref: '#/components/responses/BadRequest'
5970 $ref: '#/components/responses/Unauthorized'
5972 $ref: '#/components/responses/Forbidden'
5974 $ref: '#/components/responses/NotFound'
5976 $ref: '#/components/responses/MethodNotAllowed'
5978 $ref: '#/components/responses/NotAcceptable'
5980 $ref: '#/components/responses/Conflict'
5982 $ref: '#/components/responses/UnprocessableEntity'
5984 $ref: '#/components/responses/InternalServerError'
5986 $ref: '#/components/responses/ServiceUnavailable'
5988 $ref: '#/components/responses/UnexpectedError'
5990 $ref: '#/components/responses/UnexpectedError'
5991 '/admin/v1/vca/{vcaId}':
6004 summary: Query information about an individual VCA
6005 description: Query information about an individual VCA
6013 $ref: '#/components/schemas/VcaInfo'
6016 $ref: '#/components/schemas/VcaInfo'
6018 $ref: '#/components/responses/BadRequest'
6020 $ref: '#/components/responses/Unauthorized'
6022 $ref: '#/components/responses/Forbidden'
6024 $ref: '#/components/responses/NotFound'
6026 $ref: '#/components/responses/MethodNotAllowed'
6028 $ref: '#/components/responses/NotAcceptable'
6030 $ref: '#/components/responses/Conflict'
6032 $ref: '#/components/responses/UnprocessableEntity'
6034 $ref: '#/components/responses/InternalServerError'
6036 $ref: '#/components/responses/ServiceUnavailable'
6038 $ref: '#/components/responses/UnexpectedError'
6040 $ref: '#/components/responses/UnexpectedError'
6045 summary: Modify a VCA
6046 description: Modify a VCA
6047 operationId: editVca
6049 $ref: '#/components/requestBodies/EditVcaRequest'
6052 description: Accepted
6056 $ref: '#/components/schemas/OpId'
6059 $ref: '#/components/schemas/OpId'
6061 $ref: '#/components/responses/BadRequest'
6063 $ref: '#/components/responses/Unauthorized'
6065 $ref: '#/components/responses/Forbidden'
6067 $ref: '#/components/responses/NotFound'
6069 $ref: '#/components/responses/MethodNotAllowed'
6071 $ref: '#/components/responses/NotAcceptable'
6073 $ref: '#/components/responses/Conflict'
6075 $ref: '#/components/responses/UnprocessableEntity'
6077 $ref: '#/components/responses/InternalServerError'
6079 $ref: '#/components/responses/ServiceUnavailable'
6081 $ref: '#/components/responses/UnexpectedError'
6083 $ref: '#/components/responses/UnexpectedError'
6088 summary: Delete a VCA
6089 description: Delete a VCA
6090 operationId: deleteVca
6093 description: Accepted
6095 $ref: '#/components/responses/BadRequest'
6097 $ref: '#/components/responses/Unauthorized'
6099 $ref: '#/components/responses/Forbidden'
6101 $ref: '#/components/responses/NotFound'
6103 $ref: '#/components/responses/MethodNotAllowed'
6105 $ref: '#/components/responses/NotAcceptable'
6107 $ref: '#/components/responses/Conflict'
6109 $ref: '#/components/responses/UnprocessableEntity'
6111 $ref: '#/components/responses/InternalServerError'
6113 $ref: '#/components/responses/ServiceUnavailable'
6115 $ref: '#/components/responses/UnexpectedError'
6117 $ref: '#/components/responses/UnexpectedError'
6118 '/admin/v1/k8srepos':
6123 summary: Query information about multiple K8s Repos
6124 description: Query information about multiple K8s Repos
6125 operationId: getK8sRepos
6132 $ref: '#/components/schemas/ArrayOfK8sRepoInfo'
6135 $ref: '#/components/schemas/ArrayOfK8sRepoInfo'
6137 $ref: '#/components/responses/BadRequest'
6139 $ref: '#/components/responses/Unauthorized'
6141 $ref: '#/components/responses/Forbidden'
6143 $ref: '#/components/responses/NotFound'
6145 $ref: '#/components/responses/MethodNotAllowed'
6147 $ref: '#/components/responses/NotAcceptable'
6149 $ref: '#/components/responses/Conflict'
6151 $ref: '#/components/responses/UnprocessableEntity'
6153 $ref: '#/components/responses/InternalServerError'
6155 $ref: '#/components/responses/ServiceUnavailable'
6157 $ref: '#/components/responses/UnexpectedError'
6159 $ref: '#/components/responses/UnexpectedError'
6164 summary: Create a new K8s Repo
6165 description: Create a new K8s Repo
6166 operationId: createK8sRepo
6168 $ref: '#/components/requestBodies/CreateK8sRepoRequest'
6171 description: Accepted
6175 $ref: '#/components/schemas/ObjectId_plus_OpId'
6178 $ref: '#/components/schemas/ObjectId_plus_OpId'
6180 $ref: '#/components/responses/BadRequest'
6182 $ref: '#/components/responses/Unauthorized'
6184 $ref: '#/components/responses/Forbidden'
6186 $ref: '#/components/responses/NotFound'
6188 $ref: '#/components/responses/MethodNotAllowed'
6190 $ref: '#/components/responses/NotAcceptable'
6192 $ref: '#/components/responses/Conflict'
6194 $ref: '#/components/responses/UnprocessableEntity'
6196 $ref: '#/components/responses/InternalServerError'
6198 $ref: '#/components/responses/ServiceUnavailable'
6200 $ref: '#/components/responses/UnexpectedError'
6202 $ref: '#/components/responses/UnexpectedError'
6203 '/admin/v1/k8srepos/{k8sRepoId}':
6208 description: K8s Repo ID
6216 summary: Query information about an individual K8s Repo
6217 description: Query information about an individual K8s Repo
6218 operationId: getK8sRepo
6225 $ref: '#/components/schemas/K8sRepoInfo'
6228 $ref: '#/components/schemas/K8sRepoInfo'
6230 $ref: '#/components/responses/BadRequest'
6232 $ref: '#/components/responses/Unauthorized'
6234 $ref: '#/components/responses/Forbidden'
6236 $ref: '#/components/responses/NotFound'
6238 $ref: '#/components/responses/MethodNotAllowed'
6240 $ref: '#/components/responses/NotAcceptable'
6242 $ref: '#/components/responses/Conflict'
6244 $ref: '#/components/responses/UnprocessableEntity'
6246 $ref: '#/components/responses/InternalServerError'
6248 $ref: '#/components/responses/ServiceUnavailable'
6250 $ref: '#/components/responses/UnexpectedError'
6252 $ref: '#/components/responses/UnexpectedError'
6257 summary: Delete a K8s Repo
6258 description: Delete a K8s Repo
6259 operationId: deleteK8sRepo
6262 description: Accepted
6264 $ref: '#/components/responses/BadRequest'
6266 $ref: '#/components/responses/Unauthorized'
6268 $ref: '#/components/responses/Forbidden'
6270 $ref: '#/components/responses/NotFound'
6272 $ref: '#/components/responses/MethodNotAllowed'
6274 $ref: '#/components/responses/NotAcceptable'
6276 $ref: '#/components/responses/Conflict'
6278 $ref: '#/components/responses/UnprocessableEntity'
6280 $ref: '#/components/responses/InternalServerError'
6282 $ref: '#/components/responses/ServiceUnavailable'
6284 $ref: '#/components/responses/UnexpectedError'
6286 $ref: '#/components/responses/UnexpectedError'
6290 description: Find out more about OSM
6291 url: 'https://osm.etsi.org/docs/user-guide/'
6296 description: Bad request. The server cannot process the request due to a client error.
6300 $ref: '#/components/schemas/ProblemDetails'
6302 description: Authorization information is missing or invalid.
6306 $ref: '#/components/schemas/ProblemDetails'
6308 description: Not enough permissions to do this operation.
6312 $ref: '#/components/schemas/ProblemDetails'
6314 description: The specified resource was not found.
6318 $ref: '#/components/schemas/ProblemDetails'
6320 description: This method is not supported for the requested resource.
6324 $ref: '#/components/schemas/ProblemDetails'
6326 description: The requested resource content cannot match the Accept headers sent in the request.
6330 $ref: '#/components/schemas/ProblemDetails'
6332 description: The operation cannot be executed currently, due to a conflict with the state of the resource.
6336 $ref: '#/components/schemas/ProblemDetails'
6337 UnprocessableEntity:
6338 description: The request was well-formed but was unable to be followed due to semantic errors.
6342 $ref: '#/components/schemas/ProblemDetails'
6343 InternalServerError:
6344 description: Internal server error.
6348 $ref: '#/components/schemas/ProblemDetails'
6350 description: Service temporarily unavailable.
6354 $ref: '#/components/schemas/ProblemDetails'
6356 description: Unexpected error.
6360 $ref: '#/components/schemas/ProblemDetails'
6362 description: VNF Descriptor (plaintext)
6366 $ref: '#/components/schemas/VnfDescriptor'
6368 description: VNF Package (compressed)
6372 $ref: '#/components/schemas/VnfPackage'
6374 description: NS Descriptor (plaintext)
6378 $ref: '#/components/schemas/NsDescriptor'
6380 description: NS Package (compressed)
6384 $ref: '#/components/schemas/NsPackage'
6386 description: NetSlice Template (plaintext)
6390 $ref: '#/components/schemas/NetSliceTemplate'
6392 description: NetSlice Package (compressed)
6396 $ref: '#/components/schemas/NetSlicePackage'
6397 NslcmSubscriptionResponse:
6398 description: NslcmSubscriptionResponse
6402 $ref: '#/components/schemas/NslcmSubscriptionResponse'
6405 $ref: '#/components/schemas/NslcmSubscriptionResponse'
6416 # A free list of key:value pairs
6418 additionalProperties: true
6425 CreateNsdInfoRequest:
6426 # A free list of key:value pairs
6428 additionalProperties: true
6429 NsdInfoModifications:
6431 NS Descriptor Information
6432 Only generic fields (id, name, description) are described
6433 For a full specification of the NS Descriptor see:
6434 http://osm-download.etsi.org/ftp/osm-doc/nsd.html
6438 description: NSD Identifier
6441 description: NSD Name
6444 description: NSD Description
6446 AlarmInfoModifications:
6455 description: To enable/disable the alarm.
6458 description: Threshold value of the Alarm
6462 NS Descriptor Information
6463 Only generic fields (_id, id, name, description) are described
6464 For a full specification of the NS Descriptor see:
6465 http://osm-download.etsi.org/ftp/osm-doc/nsd.html
6470 Identifier of the onboarded individual NS descriptor
6471 resource. This identifier is allocated by the NFVO.
6476 This identifier, which is allocated by the NSD
6477 designer, identifies the NSD in a globally unique
6478 way. It is copied from the NSD content and shall be
6479 present after the NSD content is on-boarded.
6483 Name of the onboarded NSD. This information is
6484 copied from the NSD content and shall be present
6485 after the NSD content is on-boarded.
6489 Description of the onboarded NSD.
6490 This information is copied from the NSD content.
6498 $ref: '#/components/schemas/NsdInfo'
6514 additionalProperties: true
6524 CreateVnfPkgInfoRequest:
6525 # A free list of key:value pairs
6527 additionalProperties: true
6528 VnfPkgInfoModifications:
6530 VNF Package Information
6531 Only generic fields (id, name, description) are described
6532 For a full specification of the VNF Descriptor see:
6533 http://osm-download.etsi.org/ftp/osm-doc/vnfd.html
6537 description: VNF Package Identifier
6540 description: VNF Package Name
6543 description: VNF Package description
6547 VNF Package Information
6548 Only generic fields (_id, id, name, description) are described
6549 For a full specification of the VNF Descriptor see:
6550 http://osm-download.etsi.org/ftp/osm-doc/vnfd.html
6555 Identifier of the VNF package. This identifier is allocated by the NFVO.
6559 description: VNF Package Identifier
6562 description: VNF Package Name
6565 description: VNF Package description
6573 $ref: '#/components/schemas/VnfPkgInfo'
6575 # Substituted by InstantiateNsRequest
6578 NS Instance Information
6579 Only generic fields (_id, id, name, description) are described
6580 For a full specification of the NS Instance see:
6581 http://osm-download.etsi.org/ftp/osm-doc/nsr.html
6585 description: Identifier of the NS instance.
6589 description: Identifier of the NS instance.
6593 description: Human readable name of the NS instance.
6596 description: Human readable description of the NS instance.
6602 InstantiateNsRequest:
6607 Human-readable name of the NS instance to be created.
6611 Identifier of the NSD that defines the NS instance to be created.
6616 Identifier of the VIM Account where the NS instance shall be created.
6635 additionalParamsForNs:
6637 additionalProperties: true
6638 additionalParamsForVnf: &additionalparamsforvnf
6647 additionalProperties: true
6651 use this namespace for all the KDU deployed in this VNF
6652 (if any). By default it is used the id of the project
6653 additionalParamsForVdu:
6662 additionalProperties: true
6666 additionalProperties: false
6667 additionalParamsForKdu:
6676 description: use this namespace for this KDU
6681 additionalProperties: true
6685 additionalProperties: false
6689 additionalProperties: false
6702 To compute automatically the target VIM for each VNF based on
6703 constrains, e.g. latency. Currently only 'PLA' is supported
6704 placement-constraints:
6706 additionalProperties: true
6740 additionalProperties: false
6755 floating-ip-required:
6759 additionalProperties: false
6763 additionalProperties: false
6802 additionalProperties: false
6816 additionalProperties: false
6818 additionalProperties: false
6830 connect additional ports to the created underlay SDN connectivity.
6831 Normally for external connectivy.
6845 additionalProperties: true
6850 additionalProperties: false
6851 internal-connection-point:
6864 additionalProperties: False
6869 additionalProperties: false
6874 additionalProperties: false
6893 additionalProperties: true
6901 additionalProperties: true
6909 additionalProperties: false
6910 vnfd-connection-point-ref:
6915 member-vnf-index-ref:
6917 vnfd-connection-point-ref:
6923 - member-vnf-index-ref
6924 - vnfd-connection-point-ref
6926 additionalProperties: false
6930 additionalProperties: false
6936 additionalProperties: false
6945 description: timeout for the scale operation
6958 scaling-group-descriptor:
6965 - scaling-group-descriptor
6967 additionalProperties: false
6971 additionalProperties: false
6975 additionalProperties: false
6978 This type represents request parameters for the "Heal NS" operation. This operation supports the healing of an NS
6979 instance by healing one or more of the VNF that are part of this NS.
6983 description: timeout for the heal operation in seconds
6987 List of VNF to be healed, together with the information needed to heal each.
6990 $ref: "#/components/schemas/HealVnfData"
6995 This type represents the information to heal a VNF that is part of an NS.
7002 Identifies the VNF instance, part of the NS, requiring a
7008 Indicates the reason why a healing procedure is required.
7012 Additional parameters passed by the NFVO as input to
7013 the healing process, specific to the VNF being healed.
7018 Flag to indicate whether or not to run day1 primitives for the VNF (default: false).
7023 List of VDU to be healed, together with the information needed to heal each.
7026 $ref: "#/components/schemas/HealVduData"
7029 This type represents the information to heal a VDU that is part of a VNF.
7036 Identifies the VDU id, part of the VNF, requiring a healing action.
7041 Indicates the VDU number when the VDU is part of a scale-group.
7046 Flag to indicate whether or not to run day1 primitives for the VDU (default: false).
7052 timeout_ns_terminate:
7053 description: timeout for terminate operation
7056 description: remove network service if termination end without error
7058 skip_terminate_primitives:
7059 description: Do not execute network service termination primitives
7061 additionalProperties: false
7065 $ref: '#/components/schemas/NsInstance'
7066 NSinstanceActionRequest:
7072 name of the primitive in the 'config-descriptor'. If the target is
7073 a kdu it can be also 'status', 'rollback' or 'upgrade'
7075 description: parameters of this primitive
7076 $ref: '#/components/schemas/KeyValuePairs'
7079 description: provide if the target action is for a vnf, vdu or kdu
7082 description: provide if the target action is for a vdu
7085 description: provide if the target action is for a kdu
7089 description: timeout for the day 1/2 operation
7094 additionalProperties: false
7097 This type represents request parameters for the "Update NS" operation. This operation supports the update of an NS
7098 instance by updating one or more of the VNFs that are part of this NS.
7106 - MODIFY_VNF_INFORMATION
7107 changeVnfPackageData:
7117 removeVnfInstanceId:
7131 additionalProperties: false
7132 # CreateNSinstanceContentRequest:
7133 # Substituted by InstantiateNsRequest
7134 CreateNSinstanceContentResponse:
7157 isAutomaticInvocation:
7199 $ref: '#/components/schemas/NsLcmOpOcc'
7202 VNF Instance Information
7203 Only generic fields (_id, id) are described
7204 For a full specification of the VNF Instance see:
7205 http://osm-download.etsi.org/ftp/osm-doc/vnfr.html
7214 ArrayOfVnfInstanceInfo:
7217 $ref: '#/components/schemas/VnfInstanceInfo'
7220 NetSlice Template Information
7221 Only generic fields (_id, id, name) are described
7222 For a full specification of the NetSlice Template see:
7223 http://osm-download.etsi.org/ftp/osm-doc/nst.html
7227 description: NetSlice Template Identifier
7231 description: Human readable NetSlice Template Identifier
7234 description: Human readable name of the NetSlice Template
7239 $ref: '#/components/schemas/NstInfo'
7240 CreateNstInfoRequest:
7241 # A free list of key:value pairs
7243 additionalProperties: true
7250 NstInfoModifications:
7252 NetSlice Template Information
7253 Only generic fields (id, name) are described
7254 For a full specification of the NetSlice Template see:
7255 http://osm-download.etsi.org/ftp/osm-doc/nst.html
7259 description: NST Identifier
7262 description: NST Name
7266 NetSlice Instance Information
7267 Only generic fields (_id, id, name, description) are described
7268 For a full specification of the NetSlice Instance see:
7269 http://osm-download.etsi.org/ftp/osm-doc/nsi.html
7273 description: Identifier of the NetSlice instance.
7277 description: Identifier of the NetSlice instance.
7281 description: Human readable name of the NetSlice instance.
7284 description: Human readable description of the NetSlice instance.
7290 ArrayOfNetSliceInstance:
7293 $ref: '#/components/schemas/NetSliceInstance'
7300 description: Identifier of the Alarm.
7304 description: Identifier of the Alarm.
7308 description: Alarm metric.
7311 description: Threshold value of the Alarm.
7315 description: Operation to be applied.
7318 description: Action to be taken.
7321 description: Current status of the alarm.
7332 $ref: '#/components/schemas/Alarm'
7334 # Substituted by InstantiateNsiRequest
7335 InstantiateNsiRequest:
7340 Human-readable name of the NetSlice instance to be created.
7344 Identifier of the NST that defines the NetSlice instance to be created.
7349 Identifier of the VIM Account where the NetSlice instance shall be created.
7365 additionalParamsForNsi:
7367 additionalProperties: true
7399 additionalParamsForNs:
7401 additionalProperties: true
7402 additionalParamsForVnf: *additionalparamsforvnf
7441 additionalProperties: false
7456 floating-ip-required:
7460 additionalProperties: false
7464 additionalProperties: false
7503 additionalProperties: false
7517 additionalProperties: false
7519 additionalProperties: false
7527 additionalProperties: false
7528 internal-connection-point:
7541 additionalProperties: False
7546 additionalProperties: false
7551 additionalProperties: false
7570 additionalProperties: true
7578 additionalProperties: true
7586 additionalProperties: false
7587 vnfd-connection-point-ref:
7592 member-vnf-index-ref:
7594 vnfd-connection-point-ref:
7600 - member-vnf-index-ref
7601 - vnfd-connection-point-ref
7603 additionalProperties: false
7607 additionalProperties: false
7609 additionalProperties: false
7628 additionalProperties: true
7631 additionalProperties: false
7637 additionalProperties: false
7638 TerminateNsiRequest:
7643 Timestamp indicating the end time of the NSI, i.e. the NSI will be terminated
7644 automatically at this timestamp. Cardinality "0" indicates the NSI termination
7645 takes place immediately.
7654 $ref: '#/components/schemas/KeyValuePairs'
7663 # CreateNsiContentRequest:
7664 # Substituted by InstantiateNsiRequest
7665 CreateNsiContentResponse:
7688 isAutomaticInvocation:
7735 $ref: '#/components/schemas/NsiLcmOpOcc'
7789 $ref: '#/components/schemas/TokenInfo'
7812 project_role_mappings:
7834 $ref: '#/components/schemas/UserInfo'
7835 ProjectRoleMappings:
7847 additionalProperties: false
7848 ProjectRoleMappingsOpt:
7859 additionalProperties: false
7871 project_role_mappings:
7872 $ref: '#/components/schemas/ProjectRoleMappings'
7876 additionalProperties: false
7883 additionalProperties: true
7886 Array edition keys must start with '$'
7887 and follow the syntax defined in: https://osm.etsi.org/wikipub/index.php/NBI_API_Description
7897 - $ref: '#/components/schemas/ShortNameList'
7898 - $ref: '#/components/schemas/ArrayEditionSchema'
7899 project_role_mappings:
7900 $ref: '#/components/schemas/ProjectRoleMappings'
7901 add_project_role_mappings:
7902 $ref: '#/components/schemas/ProjectRoleMappings'
7903 remove_project_role_mappings:
7904 $ref: '#/components/schemas/ProjectRoleMappingsOpt'
7960 additionalProperties: false
8016 additionalProperties: false
8026 $ref: '#/components/schemas/QuotasInfo'
8030 $ref: '#/components/schemas/ProjectInfo'
8031 CreateProjectRequest:
8039 $ref: '#/components/schemas/QuotasInfo'
8042 additionalProperties: false
8051 $ref: '#/components/schemas/EditQuotasInfo'
8052 additionalProperties: false
8055 additionalProperties:
8059 Permissions keys must follow the syntax 'main_topic[:subtopic[:id[:component|action|etc]]]'
8060 Permission values are either true or false
8061 EditPermissionsInfo:
8063 additionalProperties:
8067 Permissions keys must follow the syntax 'main_topic[:subtopic[:id[:component|action|etc]]]'
8068 Permission values are either true, false, or null
8078 $ref: '#/components/schemas/PermissionsInfo'
8082 $ref: '#/components/schemas/RoleInfo'
8089 $ref: '#/components/schemas/PermissionsInfo'
8092 additionalProperties: false
8099 $ref: '#/components/schemas/EditPermissionsInfo'
8100 additionalProperties: false
8131 $ref: '#/components/schemas/VimType'
8146 additionalProperties: true
8152 $ref: '#/components/schemas/VimInfo'
8170 $ref: '#/components/schemas/VimType'
8185 additionalProperties: true
8195 additionalProperties: false
8208 $ref: '#/components/schemas/VimType'
8223 additionalProperties: true
8224 additionalProperties: false
8266 $ref: '#/components/schemas/WimType'
8276 additionalProperties: true
8280 $ref: '#/components/schemas/WimInfo'
8296 $ref: '#/components/schemas/WimType'
8306 additionalProperties: true
8311 additionalProperties: false
8332 additionalProperties: true
8333 additionalProperties: false
8372 - $ref: '#/components/schemas/SdnExtraProperties'
8373 - $ref: '#/components/schemas/SdnBasicProperties'
8377 $ref: '#/components/schemas/SdnInfo'
8380 - $ref: '#/components/schemas/SdnBasicProperties'
8387 additionalProperties: false
8390 - $ref: '#/components/schemas/SdnBasicProperties'
8391 additionalProperties: false
8447 additionalProperties: false
8471 $ref: '#/components/schemas/PduInterfaces'
8475 $ref: '#/components/schemas/PduInfo'
8496 $ref: '#/components/schemas/PduInterfaces'
8501 additionalProperties: false
8522 $ref: '#/components/schemas/PduInterfaces'
8523 additionalProperties: false
8528 additionalProperties: true
8546 additionalProperties: true
8553 $ref: '#/components/schemas/K8sClusterNetList'
8560 ArrayOfK8sClusterInfo:
8563 $ref: '#/components/schemas/K8sClusterInfo'
8564 CreateK8sClusterRequest:
8578 additionalProperties: true
8585 $ref: '#/components/schemas/K8sClusterNetList'
8598 additionalProperties: false
8599 EditK8sClusterRequest:
8608 additionalProperties: true
8615 $ref: '#/components/schemas/K8sClusterNetList'
8622 additionalProperties: false
8656 additionalProperties: true
8660 $ref: '#/components/schemas/VcaInfo'
8691 additionalProperties: true
8702 additionalProperties: false
8728 additionalProperties: true
8729 additionalProperties: false
8746 $ref: '#/components/schemas/K8sRepoType'
8752 description: repository username
8755 description: repository password
8758 description: verify certificates of HTTPS-enabled servers using this CA bundle
8761 description: identify HTTPS client using this SSL certificate file
8764 description: skip tls certificate checks for the repository
8767 description: identify HTTPS client using this SSL key file
8771 $ref: '#/components/schemas/K8sRepoInfo'
8772 CreateK8sRepoRequest:
8780 $ref: '#/components/schemas/K8sRepoType'
8788 additionalProperties: false
8789 NslcmSubscriptionResponse:
8802 NslcmSubscriptionInfo:
8819 $ref: '#/components/schemas/Authenticationschema'
8820 ArrayOfNslcmSubscriptionInfo:
8823 $ref: '#/components/schemas/NslcmSubscriptionInfo'
8824 NsInstanceSubscriptionFilter:
8826 used to identify the network service
8829 - $ref: '#/components/schemas/nsdIds'
8830 - $ref: '#/components/schemas/vnfdIds'
8831 - $ref: '#/components/schemas/pnfdIds'
8832 - $ref: '#/components/schemas/nsInstanceIds'
8833 - $ref: '#/components/schemas/nsInstanceNames'
8857 nsInstanceSubscriptionFilter:
8858 $ref: '#/components/schemas/NsInstanceSubscriptionFilter'
8861 If NsLcmOperationOccurrenceNotification is selected then at least operationTypes or states is required. If NsLcmOperationOccurrenceNotification is selected then at least nsComponentTypes, lcmOpName and lcmOpOccStatus is required
8866 - NsIdentifierCreationNotification
8867 - NsIdentifierDeletionNotification
8868 - NsLcmOperationOccurrenceNotification
8869 - NsChangeNotification
8887 - PARTIALLY_COMPLETED
8900 lcmOpNameImpactingNsComponent:
8907 - VNF_SCALE_TO_LEVEL
8908 - VNF_CHANGE_FLAVOUR
8912 - VNF_CHANGE_EXT_CONN
8919 lcmOpOccStatusImpactingNsComponent:
8926 - PARTIALLY_COMPLETED
8929 Authenticationschema:
8943 NslcmSubscriptionRequest:
8947 $ref: '#/components/schemas/Nslcmsubschema'
8952 $ref: '#/components/schemas/Authenticationschema'
8958 CreateNsdInfoRequest:
8962 $ref: '#/components/schemas/CreateNsdInfoRequest'
8965 $ref: '#/components/schemas/CreateNsdInfoRequest'
8966 NsdInfoModifications:
8970 $ref: '#/components/schemas/NsdInfoModifications'
8973 $ref: '#/components/schemas/NsdInfoModifications'
8974 AlarmInfoModifications:
8978 $ref: '#/components/schemas/AlarmInfoModifications'
8981 $ref: '#/components/schemas/AlarmInfoModifications'
8986 $ref: '#/components/schemas/NsDescriptor'
8991 $ref: '#/components/schemas/NsPackage'
8992 CreateVnfPkgInfoRequest:
8996 $ref: '#/components/schemas/CreateVnfPkgInfoRequest'
8999 $ref: '#/components/schemas/CreateVnfPkgInfoRequest'
9000 VnfPkgInfoModifications:
9004 $ref: '#/components/schemas/VnfPkgInfoModifications'
9007 $ref: '#/components/schemas/VnfPkgInfoModifications'
9012 $ref: '#/components/schemas/VnfPackage'
9017 $ref: '#/components/schemas/VnfDescriptor'
9019 # Substituted by InstantiateNsRequest
9020 InstantiateNsRequest:
9024 $ref: '#/components/schemas/InstantiateNsRequest'
9027 $ref: '#/components/schemas/InstantiateNsRequest'
9032 $ref: '#/components/schemas/HealNsRequest'
9035 $ref: '#/components/schemas/HealNsRequest'
9040 $ref: '#/components/schemas/ScaleNsRequest'
9043 $ref: '#/components/schemas/ScaleNsRequest'
9048 $ref: '#/components/schemas/TerminateNsRequest'
9051 $ref: '#/components/schemas/TerminateNsRequest'
9056 $ref: '#/components/schemas/UpdateNsRequest'
9059 $ref: '#/components/schemas/UpdateNsRequest'
9060 # CreateNSinstanceContentRequest:
9061 # Substituted by InstantiateNsRequest
9062 CreateNstInfoRequest:
9066 $ref: '#/components/schemas/CreateNstInfoRequest'
9069 $ref: '#/components/schemas/CreateNstInfoRequest'
9074 $ref: '#/components/schemas/NetSliceTemplate'
9079 $ref: '#/components/schemas/NetSlicePackage'
9080 NstInfoModifications:
9084 $ref: '#/components/schemas/NstInfoModifications'
9087 $ref: '#/components/schemas/NstInfoModifications'
9089 # Substituted by InstantiateNsiRequest
9090 InstantiateNsiRequest:
9094 $ref: '#/components/schemas/InstantiateNsiRequest'
9097 $ref: '#/components/schemas/InstantiateNsiRequest'
9098 TerminateNsiRequest:
9102 $ref: '#/components/schemas/TerminateNsiRequest'
9105 $ref: '#/components/schemas/TerminateNsiRequest'
9110 $ref: '#/components/schemas/NsiActionRequest'
9113 $ref: '#/components/schemas/NsiActionRequest'
9114 # CreateNsiContentRequest:
9115 # Substituted by InstantiateNsiRequest
9120 $ref: '#/components/schemas/CreateTokenRequest'
9123 $ref: '#/components/schemas/CreateTokenRequest'
9128 $ref: '#/components/schemas/CreateUserRequest'
9131 $ref: '#/components/schemas/CreateUserRequest'
9136 $ref: '#/components/schemas/EditUserRequest'
9139 $ref: '#/components/schemas/EditUserRequest'
9140 CreateProjectRequest:
9144 $ref: '#/components/schemas/CreateProjectRequest'
9147 $ref: '#/components/schemas/CreateProjectRequest'
9152 $ref: '#/components/schemas/EditProjectRequest'
9155 $ref: '#/components/schemas/EditProjectRequest'
9160 $ref: '#/components/schemas/CreateRoleRequest'
9163 $ref: '#/components/schemas/CreateRoleRequest'
9168 $ref: '#/components/schemas/EditRoleRequest'
9171 $ref: '#/components/schemas/EditRoleRequest'
9176 $ref: '#/components/schemas/CreateVimRequest'
9179 $ref: '#/components/schemas/CreateVimRequest'
9184 $ref: '#/components/schemas/EditVimRequest'
9187 $ref: '#/components/schemas/EditVimRequest'
9192 $ref: '#/components/schemas/CreateWimRequest'
9195 $ref: '#/components/schemas/CreateWimRequest'
9200 $ref: '#/components/schemas/EditWimRequest'
9203 $ref: '#/components/schemas/EditWimRequest'
9208 $ref: '#/components/schemas/CreateSdnRequest'
9211 $ref: '#/components/schemas/CreateSdnRequest'
9216 $ref: '#/components/schemas/EditSdnRequest'
9219 $ref: '#/components/schemas/EditSdnRequest'
9224 $ref: '#/components/schemas/CreatePduRequest'
9227 $ref: '#/components/schemas/CreatePduRequest'
9232 $ref: '#/components/schemas/EditPduRequest'
9235 $ref: '#/components/schemas/EditPduRequest'
9236 CreateK8sClusterRequest:
9240 $ref: '#/components/schemas/CreateK8sClusterRequest'
9243 $ref: '#/components/schemas/CreateK8sClusterRequest'
9244 EditK8sClusterRequest:
9248 $ref: '#/components/schemas/EditK8sClusterRequest'
9251 $ref: '#/components/schemas/EditK8sClusterRequest'
9256 $ref: '#/components/schemas/CreateVcaRequest'
9259 $ref: '#/components/schemas/CreateVcaRequest'
9264 $ref: '#/components/schemas/EditVcaRequest'
9267 $ref: '#/components/schemas/EditVcaRequest'
9268 CreateK8sRepoRequest:
9272 $ref: '#/components/schemas/CreateK8sRepoRequest'
9275 $ref: '#/components/schemas/CreateK8sRepoRequest'
9276 NslcmSubscriptionRequest:
9280 $ref: '#/components/schemas/NslcmSubscriptionRequest'
9283 $ref: '#/components/schemas/NslcmSubscriptionRequest'
9284 # END REQUEST BODIES