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}/migrate':
1666 - name: nsInstanceId
1669 description: NS Instance ID
1675 summary: Migrate VNFs in a NS instance
1677 Migrate the VNFs and VDUs in a NS instance. The precondition is
1678 that the NS instance must have been created and must be in
1679 INSTANTIATED state. As a result of the success of this operation,
1680 the NFVO creates a "NS Lifecycle Operation Occurrence" resource
1681 for the request, and the NS instance state remains INSTANTIATED.
1682 operationId: migrateNSinstance
1684 $ref: '#/components/requestBodies/NSinstanceMigrateRequest'
1687 description: Accepted
1691 It must point to the new "NS Lifecycle Operation Occurrence"
1692 resource, i.e. an URI like ".../ns_lcm_op_occs/{nsLcmOpOccId}"
1697 $ref: '#/components/responses/BadRequest'
1699 $ref: '#/components/responses/Unauthorized'
1701 $ref: '#/components/responses/Forbidden'
1703 $ref: '#/components/responses/NotFound'
1705 $ref: '#/components/responses/MethodNotAllowed'
1707 $ref: '#/components/responses/NotAcceptable'
1709 $ref: '#/components/responses/Conflict'
1711 $ref: '#/components/responses/UnprocessableEntity'
1713 $ref: '#/components/responses/InternalServerError'
1715 $ref: '#/components/responses/ServiceUnavailable'
1717 $ref: '#/components/responses/UnexpectedError'
1719 $ref: '#/components/responses/UnexpectedError'
1720 '/nslcm/v1/ns_instances/{nsInstanceId}/terminate':
1722 - name: nsInstanceId
1725 description: NS Instance ID
1731 summary: Terminate a NS instance
1733 Terminate a NS instance. The precondition is that the NS instance must have
1734 been created and must be in INSTANTIATED state. As a result of the
1735 success of this operation, the NFVO creates a "NS Lifecycle Operation
1736 Occurrence" resource for the request, and the NS instance state becomes
1738 operationId: terminateNSinstance
1740 # Request data is not required
1741 $ref: '#/components/requestBodies/TerminateNsRequest'
1744 description: Accepted
1748 It must point to the new "NS Lifecycle Operation Occurrence"
1749 resource, i.e. an URI like ".../ns_lcm_op_occs/{nsLcmOpOccId}"
1756 $ref: '#/components/schemas/ObjectId'
1759 $ref: '#/components/schemas/ObjectId'
1761 $ref: '#/components/responses/BadRequest'
1763 $ref: '#/components/responses/Unauthorized'
1765 $ref: '#/components/responses/Forbidden'
1767 $ref: '#/components/responses/NotFound'
1769 $ref: '#/components/responses/MethodNotAllowed'
1771 $ref: '#/components/responses/NotAcceptable'
1773 $ref: '#/components/responses/Conflict'
1775 $ref: '#/components/responses/UnprocessableEntity'
1777 $ref: '#/components/responses/InternalServerError'
1779 $ref: '#/components/responses/ServiceUnavailable'
1781 $ref: '#/components/responses/UnexpectedError'
1783 $ref: '#/components/responses/UnexpectedError'
1784 '/nslcm/v1/ns_instances/{nsInstanceId}/action':
1786 - name: nsInstanceId
1789 description: NS Instance ID
1795 summary: Execute an action on a NS instance
1797 Execute an action on a NS instance.
1798 The NS instance must have been created and must be in INSTANTIATED state.
1799 operationId: actionOnNSinstance
1804 $ref: '#/components/schemas/NSinstanceActionRequest'
1807 $ref: '#/components/schemas/NSinstanceActionRequest'
1810 description: Accepted
1814 It must point to the new "NS Lifecycle Operation Occurrence"
1815 resource, i.e. an URI like ".../ns_lcm_op_occs/{nsLcmOpOccId}"
1822 $ref: '#/components/schemas/ObjectId'
1825 $ref: '#/components/schemas/ObjectId'
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/{nsInstanceId}/update':
1852 - name: nsInstanceId
1855 description: NS Instance ID
1861 summary: Update a NS instance
1863 Update a NS instance. The precondition is that the NS instance must have
1864 been created and must be in INSTANTIATED state. As a result of the
1865 success of this operation, the NFVO creates a "NS Lifecycle Operation
1866 Occurrence" resource for the request, and the NS instance state remains
1868 operationId: updateNSinstance
1870 $ref: '#/components/requestBodies/UpdateNsRequest'
1873 description: Accepted
1877 It must point to the new "NS Lifecycle Operation Occurrence"
1878 resource, i.e. an URI like ".../ns_lcm_op_occs/{nsLcmOpOccId}"
1883 $ref: '#/components/responses/BadRequest'
1885 $ref: '#/components/responses/Unauthorized'
1887 $ref: '#/components/responses/Forbidden'
1889 $ref: '#/components/responses/NotFound'
1891 $ref: '#/components/responses/MethodNotAllowed'
1893 $ref: '#/components/responses/NotAcceptable'
1895 $ref: '#/components/responses/Conflict'
1897 $ref: '#/components/responses/UnprocessableEntity'
1899 $ref: '#/components/responses/InternalServerError'
1901 $ref: '#/components/responses/ServiceUnavailable'
1903 $ref: '#/components/responses/UnexpectedError'
1905 $ref: '#/components/responses/UnexpectedError'
1906 '/nslcm/v1/ns_instances_content':
1910 summary: Query information about multiple NS instances
1911 description: Query information about multiple NS isntances
1912 operationId: getNSinstancesContent
1919 $ref: '#/components/schemas/ArrayOfNsInstance'
1922 $ref: '#/components/schemas/ArrayOfNsInstance'
1924 $ref: '#/components/responses/BadRequest'
1926 $ref: '#/components/responses/Unauthorized'
1928 $ref: '#/components/responses/Forbidden'
1930 $ref: '#/components/responses/NotFound'
1932 $ref: '#/components/responses/MethodNotAllowed'
1934 $ref: '#/components/responses/NotAcceptable'
1936 $ref: '#/components/responses/Conflict'
1938 $ref: '#/components/responses/UnprocessableEntity'
1940 $ref: '#/components/responses/InternalServerError'
1942 $ref: '#/components/responses/ServiceUnavailable'
1944 $ref: '#/components/responses/UnexpectedError'
1946 $ref: '#/components/responses/UnexpectedError'
1950 summary: Create a new NS instance
1951 description: Create a new NS instance
1952 operationId: createNSinstanceContent
1954 $ref: '#/components/requestBodies/InstantiateNsRequest'
1957 description: Created
1966 $ref: '#/components/schemas/CreateNSinstanceContentResponse'
1969 $ref: '#/components/schemas/CreateNSinstanceContentResponse'
1971 $ref: '#/components/responses/BadRequest'
1973 $ref: '#/components/responses/Unauthorized'
1975 $ref: '#/components/responses/Forbidden'
1977 $ref: '#/components/responses/NotFound'
1979 $ref: '#/components/responses/MethodNotAllowed'
1981 $ref: '#/components/responses/NotAcceptable'
1983 $ref: '#/components/responses/Conflict'
1985 $ref: '#/components/responses/UnprocessableEntity'
1987 $ref: '#/components/responses/InternalServerError'
1989 $ref: '#/components/responses/ServiceUnavailable'
1991 $ref: '#/components/responses/UnexpectedError'
1993 $ref: '#/components/responses/UnexpectedError'
1994 '/nslcm/v1/ns_instances_content/{nsInstanceContentId}':
1996 - name: nsInstanceContentId
1999 description: NS Instance Content ID
2005 summary: Read an individual NS instance resource
2006 description: Read an individual NS instance resource
2007 operationId: getNSinstanceContent
2014 $ref: '#/components/schemas/NsInstance'
2017 $ref: '#/components/schemas/NsInstance'
2019 $ref: '#/components/responses/BadRequest'
2021 $ref: '#/components/responses/Unauthorized'
2023 $ref: '#/components/responses/Forbidden'
2025 $ref: '#/components/responses/NotFound'
2027 $ref: '#/components/responses/MethodNotAllowed'
2029 $ref: '#/components/responses/NotAcceptable'
2031 $ref: '#/components/responses/Conflict'
2033 $ref: '#/components/responses/UnprocessableEntity'
2035 $ref: '#/components/responses/InternalServerError'
2037 $ref: '#/components/responses/ServiceUnavailable'
2039 $ref: '#/components/responses/UnexpectedError'
2041 $ref: '#/components/responses/UnexpectedError'
2045 summary: Delete an individual NS instance resource
2046 description: Delete an individual NS instance resource
2047 operationId: deleteNSinstanceContent
2050 description: Accepted
2054 $ref: '#/components/schemas/ObjectId'
2057 $ref: '#/components/schemas/ObjectId'
2059 description: No Content
2061 $ref: '#/components/responses/BadRequest'
2063 $ref: '#/components/responses/Unauthorized'
2065 $ref: '#/components/responses/Forbidden'
2067 $ref: '#/components/responses/NotFound'
2069 $ref: '#/components/responses/MethodNotAllowed'
2071 $ref: '#/components/responses/NotAcceptable'
2073 $ref: '#/components/responses/Conflict'
2075 $ref: '#/components/responses/UnprocessableEntity'
2077 $ref: '#/components/responses/InternalServerError'
2079 $ref: '#/components/responses/ServiceUnavailable'
2081 $ref: '#/components/responses/UnexpectedError'
2083 $ref: '#/components/responses/UnexpectedError'
2084 '/nslcm/v1/ns_lcm_op_occs':
2088 summary: Query information about multiple NS LCM Operation Occurrences
2089 description: Query information about multiple NS LCM Operation Occurrences
2090 operationId: getNSLCMOpOccs
2097 $ref: '#/components/schemas/ArrayOfNsLcmOpOcc'
2100 $ref: '#/components/schemas/ArrayOfNsLcmOpOcc'
2102 $ref: '#/components/responses/BadRequest'
2104 $ref: '#/components/responses/Unauthorized'
2106 $ref: '#/components/responses/Forbidden'
2108 $ref: '#/components/responses/NotFound'
2110 $ref: '#/components/responses/MethodNotAllowed'
2112 $ref: '#/components/responses/NotAcceptable'
2114 $ref: '#/components/responses/Conflict'
2116 $ref: '#/components/responses/UnprocessableEntity'
2118 $ref: '#/components/responses/InternalServerError'
2120 $ref: '#/components/responses/ServiceUnavailable'
2122 $ref: '#/components/responses/UnexpectedError'
2124 $ref: '#/components/responses/UnexpectedError'
2125 '/nslcm/v1/ns_lcm_op_occs/{nsLcmOpOccId}':
2127 - name: nsLcmOpOccId
2130 description: NS LCM Operation Occurrence ID
2136 summary: Query information about an individual NS LCM Operation Occurrence
2137 description: Query information about an individual NS LCM Operation Occurrence
2138 operationId: getNSLCMOpOcc
2145 $ref: '#/components/schemas/NsLcmOpOcc'
2148 $ref: '#/components/schemas/NsLcmOpOcc'
2150 $ref: '#/components/responses/BadRequest'
2152 $ref: '#/components/responses/Unauthorized'
2154 $ref: '#/components/responses/Forbidden'
2156 $ref: '#/components/responses/NotFound'
2158 $ref: '#/components/responses/MethodNotAllowed'
2160 $ref: '#/components/responses/NotAcceptable'
2162 $ref: '#/components/responses/Conflict'
2164 $ref: '#/components/responses/UnprocessableEntity'
2166 $ref: '#/components/responses/InternalServerError'
2168 $ref: '#/components/responses/ServiceUnavailable'
2170 $ref: '#/components/responses/UnexpectedError'
2172 $ref: '#/components/responses/UnexpectedError'
2173 '/nslcm/v1/vnf_instances':
2177 summary: Query information about multiple VNF Instances
2178 description: Query information about multiple VNF Instances
2179 operationId: getVnfInstances
2186 $ref: '#/components/schemas/ArrayOfVnfInstanceInfo'
2189 $ref: '#/components/schemas/ArrayOfVnfInstanceInfo'
2191 $ref: '#/components/responses/BadRequest'
2193 $ref: '#/components/responses/Unauthorized'
2195 $ref: '#/components/responses/Forbidden'
2197 $ref: '#/components/responses/NotFound'
2199 $ref: '#/components/responses/MethodNotAllowed'
2201 $ref: '#/components/responses/NotAcceptable'
2203 $ref: '#/components/responses/Conflict'
2205 $ref: '#/components/responses/UnprocessableEntity'
2207 $ref: '#/components/responses/InternalServerError'
2209 $ref: '#/components/responses/ServiceUnavailable'
2211 $ref: '#/components/responses/UnexpectedError'
2213 $ref: '#/components/responses/UnexpectedError'
2214 '/nslcm/v1/vnf_instances/{vnfInstanceId}':
2216 - name: vnfInstanceId
2219 description: VNF Instance ID
2225 summary: Query information about an individual VNF Instance
2226 description: Query information about an individual VNF Instance
2227 operationId: getVnfInstance
2234 $ref: '#/components/schemas/VnfInstanceInfo'
2237 $ref: '#/components/schemas/VnfInstanceInfo'
2239 $ref: '#/components/responses/BadRequest'
2241 $ref: '#/components/responses/Unauthorized'
2243 $ref: '#/components/responses/Forbidden'
2245 $ref: '#/components/responses/NotFound'
2247 $ref: '#/components/responses/MethodNotAllowed'
2249 $ref: '#/components/responses/NotAcceptable'
2251 $ref: '#/components/responses/Conflict'
2253 $ref: '#/components/responses/UnprocessableEntity'
2255 $ref: '#/components/responses/InternalServerError'
2257 $ref: '#/components/responses/ServiceUnavailable'
2259 $ref: '#/components/responses/UnexpectedError'
2261 $ref: '#/components/responses/UnexpectedError'
2262 '/nslcm/v1/subscriptions':
2266 summary: Query information about multiple NS instance subscription
2267 description: Query information about multiple NS instance subscription
2268 operationId: getNsSubcriptions
2275 $ref: '#/components/schemas/ArrayOfNslcmSubscriptionInfo'
2278 $ref: '#/components/schemas/ArrayOfNslcmSubscriptionInfo'
2280 $ref: '#/components/responses/BadRequest'
2282 $ref: '#/components/responses/Unauthorized'
2284 $ref: '#/components/responses/Forbidden'
2286 $ref: '#/components/responses/NotFound'
2288 $ref: '#/components/responses/MethodNotAllowed'
2290 $ref: '#/components/responses/NotAcceptable'
2292 $ref: '#/components/responses/Conflict'
2294 $ref: '#/components/responses/UnprocessableEntity'
2296 $ref: '#/components/responses/InternalServerError'
2298 $ref: '#/components/responses/ServiceUnavailable'
2300 $ref: '#/components/responses/UnexpectedError'
2302 $ref: '#/components/responses/UnexpectedError'
2306 summary: Create a new subscription for the Network service
2307 description: Create a new subscription for the Network service
2308 operationId: addNsSubcriptions
2310 $ref: '#/components/requestBodies/NslcmSubscriptionRequest'
2313 description: Created
2321 $ref: '#/components/schemas/NslcmSubscriptionResponse'
2324 $ref: '#/components/schemas/NslcmSubscriptionResponse'
2326 $ref: '#/components/responses/BadRequest'
2328 $ref: '#/components/responses/Unauthorized'
2330 $ref: '#/components/responses/Forbidden'
2332 $ref: '#/components/responses/NotFound'
2334 $ref: '#/components/responses/MethodNotAllowed'
2336 $ref: '#/components/responses/NotAcceptable'
2338 $ref: '#/components/responses/Conflict'
2340 $ref: '#/components/responses/UnprocessableEntity'
2342 $ref: '#/components/responses/InternalServerError'
2344 $ref: '#/components/responses/ServiceUnavailable'
2346 $ref: '#/components/responses/UnexpectedError'
2348 $ref: '#/components/responses/UnexpectedError'
2349 '/nslcm/v1/subscriptions/{nsSubscriptionsId}':
2351 - name: nsSubscriptionsId
2354 description: Network Service Subscription ID
2360 summary: Read information about an individual Network Service Subscription
2361 description: Read information about an individual Network Service Subscription
2362 operationId: getNsSubcriptionId
2369 $ref: '#/components/schemas/NslcmSubscriptionInfo'
2372 $ref: '#/components/schemas/NslcmSubscriptionInfo'
2374 $ref: '#/components/responses/BadRequest'
2376 $ref: '#/components/responses/Unauthorized'
2378 $ref: '#/components/responses/Forbidden'
2380 $ref: '#/components/responses/NotFound'
2382 $ref: '#/components/responses/MethodNotAllowed'
2384 $ref: '#/components/responses/NotAcceptable'
2386 $ref: '#/components/responses/Conflict'
2388 $ref: '#/components/responses/UnprocessableEntity'
2390 $ref: '#/components/responses/InternalServerError'
2392 $ref: '#/components/responses/ServiceUnavailable'
2394 $ref: '#/components/responses/UnexpectedError'
2396 $ref: '#/components/responses/UnexpectedError'
2400 summary: Delete an individual Network Service Subscription
2401 description: Delete an individual Network Service Subscription
2402 operationId: deleteNsSubcriptionId
2405 description: No Content
2407 $ref: '#/components/responses/BadRequest'
2409 $ref: '#/components/responses/Unauthorized'
2411 $ref: '#/components/responses/Forbidden'
2413 $ref: '#/components/responses/NotFound'
2415 $ref: '#/components/responses/MethodNotAllowed'
2417 $ref: '#/components/responses/NotAcceptable'
2419 $ref: '#/components/responses/Conflict'
2421 $ref: '#/components/responses/UnprocessableEntity'
2423 $ref: '#/components/responses/InternalServerError'
2425 $ref: '#/components/responses/ServiceUnavailable'
2427 $ref: '#/components/responses/UnexpectedError'
2429 $ref: '#/components/responses/UnexpectedError'
2437 summary: Query information about multiple alarms
2438 description: Query information about multiple alarms
2439 operationId: getAlarms
2446 $ref: '#/components/schemas/ArrayOfAlarm'
2449 $ref: '#/components/schemas/ArrayOfAlarm'
2451 $ref: '#/components/responses/BadRequest'
2453 $ref: '#/components/responses/Unauthorized'
2455 $ref: '#/components/responses/Forbidden'
2457 $ref: '#/components/responses/NotFound'
2459 $ref: '#/components/responses/MethodNotAllowed'
2461 $ref: '#/components/responses/NotAcceptable'
2463 $ref: '#/components/responses/Conflict'
2465 $ref: '#/components/responses/UnprocessableEntity'
2467 $ref: '#/components/responses/InternalServerError'
2469 $ref: '#/components/responses/ServiceUnavailable'
2471 $ref: '#/components/responses/UnexpectedError'
2473 $ref: '#/components/responses/UnexpectedError'
2474 '/nsfm/v1/alarms/{uuid}':
2479 description: Alarm UUID
2485 summary: Read an individual Alarm
2486 description: Read an individual Alarm
2487 operationId: getAlarm
2494 $ref: '#/components/schemas/Alarm'
2497 $ref: '#/components/schemas/Alarm'
2499 $ref: '#/components/responses/BadRequest'
2501 $ref: '#/components/responses/Unauthorized'
2503 $ref: '#/components/responses/Forbidden'
2505 $ref: '#/components/responses/NotFound'
2507 $ref: '#/components/responses/MethodNotAllowed'
2509 $ref: '#/components/responses/NotAcceptable'
2511 $ref: '#/components/responses/Conflict'
2513 $ref: '#/components/responses/UnprocessableEntity'
2515 $ref: '#/components/responses/InternalServerError'
2517 $ref: '#/components/responses/ServiceUnavailable'
2519 $ref: '#/components/responses/UnexpectedError'
2521 $ref: '#/components/responses/UnexpectedError'
2525 summary: Modify the data of an individual Alarm
2526 description: Modify the data of an individual Alarm
2527 operationId: updateAlarm
2529 $ref: '#/components/requestBodies/AlarmInfoModifications'
2532 description: No Content
2534 $ref: '#/components/responses/BadRequest'
2536 $ref: '#/components/responses/Unauthorized'
2538 $ref: '#/components/responses/Forbidden'
2540 $ref: '#/components/responses/NotFound'
2542 $ref: '#/components/responses/MethodNotAllowed'
2544 $ref: '#/components/responses/NotAcceptable'
2546 $ref: '#/components/responses/Conflict'
2548 $ref: '#/components/responses/UnprocessableEntity'
2550 $ref: '#/components/responses/InternalServerError'
2552 $ref: '#/components/responses/ServiceUnavailable'
2554 $ref: '#/components/responses/UnexpectedError'
2556 $ref: '#/components/responses/UnexpectedError'
2559 # BEGIN NetSlice Templates
2560 '/nst/v1/netslice_templates':
2563 - "NetSlice templates"
2564 summary: Query information about multiple NetSlice template resources
2565 description: Query information about multiple NetSlice template resources
2566 operationId: getNSTs
2573 $ref: '#/components/schemas/ArrayOfNstInfo'
2576 $ref: '#/components/schemas/ArrayOfNstInfo'
2578 $ref: '#/components/responses/BadRequest'
2580 $ref: '#/components/responses/Unauthorized'
2582 $ref: '#/components/responses/Forbidden'
2584 $ref: '#/components/responses/NotFound'
2586 $ref: '#/components/responses/MethodNotAllowed'
2588 $ref: '#/components/responses/NotAcceptable'
2590 $ref: '#/components/responses/Conflict'
2592 $ref: '#/components/responses/UnprocessableEntity'
2594 $ref: '#/components/responses/InternalServerError'
2596 $ref: '#/components/responses/ServiceUnavailable'
2598 $ref: '#/components/responses/UnexpectedError'
2600 $ref: '#/components/responses/UnexpectedError'
2603 - "NetSlice templates"
2604 summary: Create a new NetSlice template resource
2605 description: Create a new NetSlice template resource
2608 $ref: '#/components/requestBodies/CreateNstInfoRequest'
2611 description: Created
2620 $ref: '#/components/schemas/ObjectId'
2623 $ref: '#/components/schemas/ObjectId'
2625 $ref: '#/components/responses/BadRequest'
2627 $ref: '#/components/responses/Unauthorized'
2629 $ref: '#/components/responses/Forbidden'
2631 $ref: '#/components/responses/NotFound'
2633 $ref: '#/components/responses/MethodNotAllowed'
2635 $ref: '#/components/responses/NotAcceptable'
2637 $ref: '#/components/responses/Conflict'
2639 $ref: '#/components/responses/UnprocessableEntity'
2641 $ref: '#/components/responses/InternalServerError'
2643 $ref: '#/components/responses/ServiceUnavailable'
2645 $ref: '#/components/responses/UnexpectedError'
2647 $ref: '#/components/responses/UnexpectedError'
2648 '/nst/v1/netslice_templates/{netsliceTemplateId}':
2650 - name: netsliceTemplateId
2653 description: NetSlice Template ID
2658 - "NetSlice templates"
2659 summary: Read information about an individual NetSlice template resource
2660 description: Read information about an individual NetSlice template resource
2668 $ref: '#/components/schemas/NstInfo'
2671 $ref: '#/components/schemas/NstInfo'
2673 $ref: '#/components/responses/BadRequest'
2675 $ref: '#/components/responses/Unauthorized'
2677 $ref: '#/components/responses/Forbidden'
2679 $ref: '#/components/responses/NotFound'
2681 $ref: '#/components/responses/MethodNotAllowed'
2683 $ref: '#/components/responses/NotAcceptable'
2685 $ref: '#/components/responses/Conflict'
2687 $ref: '#/components/responses/UnprocessableEntity'
2689 $ref: '#/components/responses/InternalServerError'
2691 $ref: '#/components/responses/ServiceUnavailable'
2693 $ref: '#/components/responses/UnexpectedError'
2695 $ref: '#/components/responses/UnexpectedError'
2698 - "NetSlice templates"
2699 summary: Delete an individual NetSlice template resource
2700 description: Delete an individual NetSlice template resource
2701 operationId: deleteNST
2704 description: No Content
2706 $ref: '#/components/responses/BadRequest'
2708 $ref: '#/components/responses/Unauthorized'
2710 $ref: '#/components/responses/Forbidden'
2712 $ref: '#/components/responses/NotFound'
2714 $ref: '#/components/responses/MethodNotAllowed'
2716 $ref: '#/components/responses/NotAcceptable'
2718 $ref: '#/components/responses/Conflict'
2720 $ref: '#/components/responses/UnprocessableEntity'
2722 $ref: '#/components/responses/InternalServerError'
2724 $ref: '#/components/responses/ServiceUnavailable'
2726 $ref: '#/components/responses/UnexpectedError'
2728 $ref: '#/components/responses/UnexpectedError'
2729 '/nst/v1/netslice_templates/{netsliceTemplateId}/artifacts/{artifactPath}':
2731 - name: netsliceTemplateId
2734 description: NetSlice Template ID
2737 - name: artifactPath
2740 description: Artifact Path
2745 - "NetSlice templates"
2746 summary: Fetch individual NetSlice Template artifact
2747 description: Fetch individual NetSlice Template artifact
2748 operationId: getNstArtifact
2753 application/octet-stream:
2758 description: Partial Content
2764 application/octet-stream:
2769 $ref: '#/components/responses/BadRequest'
2771 $ref: '#/components/responses/Unauthorized'
2773 $ref: '#/components/responses/Forbidden'
2775 $ref: '#/components/responses/NotFound'
2777 $ref: '#/components/responses/MethodNotAllowed'
2779 $ref: '#/components/responses/NotAcceptable'
2781 $ref: '#/components/responses/Conflict'
2783 $ref: '#/components/responses/UnprocessableEntity'
2785 $ref: '#/components/responses/InternalServerError'
2787 $ref: '#/components/responses/ServiceUnavailable'
2789 $ref: '#/components/responses/UnexpectedError'
2791 $ref: '#/components/responses/UnexpectedError'
2792 '/nst/v1/netslice_templates/{netsliceTemplateId}/nst':
2794 - name: netsliceTemplateId
2797 description: NetSlice Template ID
2802 - "NetSlice templates"
2803 summary: Read NST of an on-boarded NetSlice Template
2804 description: Read NST of an on-boarded NetSlice Template
2805 operationId: getNstNst
2812 $ref: '#/components/schemas/NetSliceTemplate'
2814 $ref: '#/components/responses/BadRequest'
2816 $ref: '#/components/responses/Unauthorized'
2818 $ref: '#/components/responses/Forbidden'
2820 $ref: '#/components/responses/NotFound'
2822 $ref: '#/components/responses/MethodNotAllowed'
2824 $ref: '#/components/responses/NotAcceptable'
2826 $ref: '#/components/responses/Conflict'
2828 $ref: '#/components/responses/UnprocessableEntity'
2830 $ref: '#/components/responses/InternalServerError'
2832 $ref: '#/components/responses/ServiceUnavailable'
2834 $ref: '#/components/responses/UnexpectedError'
2836 $ref: '#/components/responses/UnexpectedError'
2837 '/nst/v1/netslice_templates/{netsliceTemplateId}/nst_content':
2839 - name: netsliceTemplateId
2842 description: NetSlice Template ID
2847 - "NetSlice templates"
2848 summary: Fetch the content of a NST
2849 description: Fetch the content of a NST
2850 operationId: getNSTcontent
2857 $ref: '#/components/schemas/NetSlicePackage'
2859 description: Partial Content
2867 $ref: '#/components/schemas/NetSlicePackage'
2869 $ref: '#/components/responses/BadRequest'
2871 $ref: '#/components/responses/Unauthorized'
2873 $ref: '#/components/responses/Forbidden'
2875 $ref: '#/components/responses/NotFound'
2877 $ref: '#/components/responses/MethodNotAllowed'
2879 $ref: '#/components/responses/NotAcceptable'
2881 $ref: '#/components/responses/Conflict'
2883 $ref: '#/components/responses/UnprocessableEntity'
2885 $ref: '#/components/responses/InternalServerError'
2887 $ref: '#/components/responses/ServiceUnavailable'
2889 $ref: '#/components/responses/UnexpectedError'
2891 $ref: '#/components/responses/UnexpectedError'
2894 - "NetSlice templates"
2895 summary: Upload the content of a NST
2896 description: Upload the content of a NST
2897 operationId: updateNSTcontent
2899 $ref: '#/components/requestBodies/NetSlicePackage'
2902 description: Accepted
2904 description: No Content
2906 $ref: '#/components/responses/BadRequest'
2908 $ref: '#/components/responses/Unauthorized'
2910 $ref: '#/components/responses/Forbidden'
2912 $ref: '#/components/responses/NotFound'
2914 $ref: '#/components/responses/MethodNotAllowed'
2916 $ref: '#/components/responses/NotAcceptable'
2918 $ref: '#/components/responses/Conflict'
2920 $ref: '#/components/responses/UnprocessableEntity'
2922 $ref: '#/components/responses/InternalServerError'
2924 $ref: '#/components/responses/ServiceUnavailable'
2926 $ref: '#/components/responses/UnexpectedError'
2928 $ref: '#/components/responses/UnexpectedError'
2929 '/nst/v1/netslice_templates_content':
2932 - "NetSlice templates"
2933 summary: Upload a NetSlice package by providing the content of the NetSlice package
2934 description: Upload a NetSlice package by providing the content of the NetSlice package
2935 operationId: uploadNstContent
2940 $ref: '#/components/schemas/NetSlicePackage'
2943 description: Created
2952 $ref: '#/components/schemas/ObjectId'
2955 $ref: '#/components/schemas/ObjectId'
2957 description: Accepted
2959 description: No Content
2961 $ref: '#/components/responses/BadRequest'
2963 $ref: '#/components/responses/Unauthorized'
2965 $ref: '#/components/responses/Forbidden'
2967 $ref: '#/components/responses/NotFound'
2969 $ref: '#/components/responses/MethodNotAllowed'
2971 $ref: '#/components/responses/NotAcceptable'
2973 $ref: '#/components/responses/Conflict'
2975 $ref: '#/components/responses/UnprocessableEntity'
2977 $ref: '#/components/responses/InternalServerError'
2979 $ref: '#/components/responses/ServiceUnavailable'
2981 $ref: '#/components/responses/UnexpectedError'
2983 $ref: '#/components/responses/UnexpectedError'
2986 - "NetSlice templates"
2987 summary: Query information about multiple NetSlice Template resources
2988 description: Query information about multiple NetSlice Template resources
2989 operationId: getNstContent
2996 $ref: '#/components/schemas/ArrayOfNstInfo'
2999 $ref: '#/components/schemas/ArrayOfNstInfo'
3001 description: Partial Content
3007 application/octet-stream:
3012 $ref: '#/components/responses/BadRequest'
3014 $ref: '#/components/responses/Unauthorized'
3016 $ref: '#/components/responses/Forbidden'
3018 $ref: '#/components/responses/NotFound'
3020 $ref: '#/components/responses/MethodNotAllowed'
3022 $ref: '#/components/responses/NotAcceptable'
3024 $ref: '#/components/responses/Conflict'
3026 $ref: '#/components/responses/UnprocessableEntity'
3028 $ref: '#/components/responses/InternalServerError'
3030 $ref: '#/components/responses/ServiceUnavailable'
3032 $ref: '#/components/responses/UnexpectedError'
3034 $ref: '#/components/responses/UnexpectedError'
3035 '/nst/v1/netslice_templates_content/{netsliceTemplateContentId}':
3037 - name: netsliceTemplateContentId
3040 description: NetSlice Template ID
3045 - "NetSlice templates"
3046 summary: Read information about an individual NetSlice Template resource
3047 description: Read information about an individual NetSlice Template resource
3048 operationId: getNstIdContent
3055 $ref: '#/components/schemas/NstInfo'
3058 $ref: '#/components/schemas/NstInfo'
3060 $ref: '#/components/responses/BadRequest'
3062 $ref: '#/components/responses/Unauthorized'
3064 $ref: '#/components/responses/Forbidden'
3066 $ref: '#/components/responses/NotFound'
3068 $ref: '#/components/responses/MethodNotAllowed'
3070 $ref: '#/components/responses/NotAcceptable'
3072 $ref: '#/components/responses/Conflict'
3074 $ref: '#/components/responses/UnprocessableEntity'
3076 $ref: '#/components/responses/InternalServerError'
3078 $ref: '#/components/responses/ServiceUnavailable'
3080 $ref: '#/components/responses/UnexpectedError'
3082 $ref: '#/components/responses/UnexpectedError'
3085 - "NetSlice templates"
3086 summary: Modify an individual NetSlice Template resource
3087 description: Modify an individual NetSlice Template resource
3088 operationId: updateNstIdContent
3090 $ref: '#/components/requestBodies/NstInfoModifications'
3093 description: No Content
3095 $ref: '#/components/responses/BadRequest'
3097 $ref: '#/components/responses/Unauthorized'
3099 $ref: '#/components/responses/Forbidden'
3101 $ref: '#/components/responses/NotFound'
3103 $ref: '#/components/responses/MethodNotAllowed'
3105 $ref: '#/components/responses/NotAcceptable'
3107 $ref: '#/components/responses/Conflict'
3109 $ref: '#/components/responses/UnprocessableEntity'
3111 $ref: '#/components/responses/InternalServerError'
3113 $ref: '#/components/responses/ServiceUnavailable'
3115 $ref: '#/components/responses/UnexpectedError'
3117 $ref: '#/components/responses/UnexpectedError'
3120 - "NetSlice templates"
3121 summary: Delete an individual NetSlice Template resource
3122 description: Delete an individual NetSlice Template resource
3123 operationId: deleteNstIdContent
3126 description: No Content
3128 $ref: '#/components/responses/BadRequest'
3130 $ref: '#/components/responses/Unauthorized'
3132 $ref: '#/components/responses/Forbidden'
3134 $ref: '#/components/responses/NotFound'
3136 $ref: '#/components/responses/MethodNotAllowed'
3138 $ref: '#/components/responses/NotAcceptable'
3140 $ref: '#/components/responses/Conflict'
3142 $ref: '#/components/responses/UnprocessableEntity'
3144 $ref: '#/components/responses/InternalServerError'
3146 $ref: '#/components/responses/ServiceUnavailable'
3148 $ref: '#/components/responses/UnexpectedError'
3150 $ref: '#/components/responses/UnexpectedError'
3151 # END NetSlice Templates
3153 # BEGIN NetSlice Instances
3154 '/nsilcm/v1/netslice_instances':
3157 - "NetSlice instances"
3158 summary: Query information about multiple NetSlice instances
3159 description: Query information about multiple NetSlice isntances
3160 operationId: getNSIs
3167 $ref: '#/components/schemas/ArrayOfNetSliceInstance'
3170 $ref: '#/components/schemas/ArrayOfNetSliceInstance'
3172 $ref: '#/components/responses/BadRequest'
3174 $ref: '#/components/responses/Unauthorized'
3176 $ref: '#/components/responses/Forbidden'
3178 $ref: '#/components/responses/NotFound'
3180 $ref: '#/components/responses/MethodNotAllowed'
3182 $ref: '#/components/responses/NotAcceptable'
3184 $ref: '#/components/responses/Conflict'
3186 $ref: '#/components/responses/UnprocessableEntity'
3188 $ref: '#/components/responses/InternalServerError'
3190 $ref: '#/components/responses/ServiceUnavailable'
3192 $ref: '#/components/responses/UnexpectedError'
3194 $ref: '#/components/responses/UnexpectedError'
3197 - "NetSlice instances"
3198 summary: Create a new NetSlice instance resource
3199 description: Create a new NetSlice instance resource
3202 $ref: '#/components/requestBodies/InstantiateNsiRequest'
3205 description: Created
3214 $ref: '#/components/schemas/ObjectId'
3217 $ref: '#/components/schemas/ObjectId'
3219 $ref: '#/components/responses/BadRequest'
3221 $ref: '#/components/responses/Unauthorized'
3223 $ref: '#/components/responses/Forbidden'
3225 $ref: '#/components/responses/NotFound'
3227 $ref: '#/components/responses/MethodNotAllowed'
3229 $ref: '#/components/responses/NotAcceptable'
3231 $ref: '#/components/responses/Conflict'
3233 $ref: '#/components/responses/UnprocessableEntity'
3235 $ref: '#/components/responses/InternalServerError'
3237 $ref: '#/components/responses/ServiceUnavailable'
3239 $ref: '#/components/responses/UnexpectedError'
3241 $ref: '#/components/responses/UnexpectedError'
3242 '/nsilcm/v1/netslice_instances/{netsliceInstanceId}':
3244 - name: netsliceInstanceId
3247 description: NetSlice Instance ID
3252 - "NetSlice instances"
3253 summary: Read an individual NetSlice instance resource
3254 description: Read an individual NetSlice instance resource
3262 $ref: '#/components/schemas/NetSliceInstance'
3265 $ref: '#/components/schemas/NetSliceInstance'
3267 $ref: '#/components/responses/BadRequest'
3269 $ref: '#/components/responses/Unauthorized'
3271 $ref: '#/components/responses/Forbidden'
3273 $ref: '#/components/responses/NotFound'
3275 $ref: '#/components/responses/MethodNotAllowed'
3277 $ref: '#/components/responses/NotAcceptable'
3279 $ref: '#/components/responses/Conflict'
3281 $ref: '#/components/responses/UnprocessableEntity'
3283 $ref: '#/components/responses/InternalServerError'
3285 $ref: '#/components/responses/ServiceUnavailable'
3287 $ref: '#/components/responses/UnexpectedError'
3289 $ref: '#/components/responses/UnexpectedError'
3292 - "NetSlice instances"
3293 summary: Delete an individual NetSlice instance resource
3294 description: Delete an individual NetSlice instance resource
3295 operationId: deleteNSI
3298 description: No Content
3300 $ref: '#/components/responses/BadRequest'
3302 $ref: '#/components/responses/Unauthorized'
3304 $ref: '#/components/responses/Forbidden'
3306 $ref: '#/components/responses/NotFound'
3308 $ref: '#/components/responses/MethodNotAllowed'
3310 $ref: '#/components/responses/NotAcceptable'
3312 $ref: '#/components/responses/Conflict'
3314 $ref: '#/components/responses/UnprocessableEntity'
3316 $ref: '#/components/responses/InternalServerError'
3318 $ref: '#/components/responses/ServiceUnavailable'
3320 $ref: '#/components/responses/UnexpectedError'
3322 $ref: '#/components/responses/UnexpectedError'
3323 '/nsilcm/v1/netslice_instances/{netsliceInstanceId}/instantiate':
3325 - name: netsliceInstanceId
3328 description: NetSlice Instance ID
3333 - "NetSlice instances"
3334 summary: Instantiate a NetSlice
3336 Instantiate a NetSlice. The precondition is that the NetSlice instance
3337 must have been created and must be in NOT_INSTANTIATED state. As a result
3338 of the success of this operation, the NFVO creates a "NetSlice Lifecycle
3339 Operation Occurrence" resource for the request, and the NS instance state
3340 becomes INSTANTIATED.
3341 operationId: instantiateNSI
3343 $ref: '#/components/requestBodies/InstantiateNsiRequest'
3346 description: Accepted
3350 It must point to the new "NetSlice Lifecycle Operation Occurrence"
3351 resource, i.e. an URI like ".../nsi_lcm_op_occs/{nsiLcmOpOccId}"
3358 $ref: '#/components/schemas/ObjectId'
3361 $ref: '#/components/schemas/ObjectId'
3363 $ref: '#/components/responses/BadRequest'
3365 $ref: '#/components/responses/Unauthorized'
3367 $ref: '#/components/responses/Forbidden'
3369 $ref: '#/components/responses/NotFound'
3371 $ref: '#/components/responses/MethodNotAllowed'
3373 $ref: '#/components/responses/NotAcceptable'
3375 $ref: '#/components/responses/Conflict'
3377 $ref: '#/components/responses/UnprocessableEntity'
3379 $ref: '#/components/responses/InternalServerError'
3381 $ref: '#/components/responses/ServiceUnavailable'
3383 $ref: '#/components/responses/UnexpectedError'
3385 $ref: '#/components/responses/UnexpectedError'
3386 '/nsilcm/v1/netslice_instances/{netsliceInstanceId}/terminate':
3388 - name: netsliceInstanceId
3391 description: NetSlice Instance ID
3396 - "NetSlice instances"
3397 summary: Terminate a NetSlice instance
3399 Terminate a NetSlice instance. The precondition is that the NetSlice instance
3400 must have been created and must be in INSTANTIATED state. As a result of the
3401 success of this operation, the NFVO creates a "NetSlice Lifecycle Operation
3402 Occurrence" resource for the request, and the NetSlice instance state becomes
3404 operationId: terminateNSI
3406 # Request data is not required
3407 $ref: '#/components/requestBodies/TerminateNsiRequest'
3410 description: Accepted
3414 It must point to the new "NetSlice Lifecycle Operation Occurrence"
3415 resource, i.e. an URI like ".../nsi_lcm_op_occs/{nsiLcmOpOccId}"
3422 $ref: '#/components/schemas/ObjectId'
3425 $ref: '#/components/schemas/ObjectId'
3427 $ref: '#/components/responses/BadRequest'
3429 $ref: '#/components/responses/Unauthorized'
3431 $ref: '#/components/responses/Forbidden'
3433 $ref: '#/components/responses/NotFound'
3435 $ref: '#/components/responses/MethodNotAllowed'
3437 $ref: '#/components/responses/NotAcceptable'
3439 $ref: '#/components/responses/Conflict'
3441 $ref: '#/components/responses/UnprocessableEntity'
3443 $ref: '#/components/responses/InternalServerError'
3445 $ref: '#/components/responses/ServiceUnavailable'
3447 $ref: '#/components/responses/UnexpectedError'
3449 $ref: '#/components/responses/UnexpectedError'
3450 '/nsilcm/v1/netslice_instances/{netsliceInstanceId}/action':
3452 - name: netsliceInstanceId
3455 description: NetSlice Instance ID
3460 - "NetSlice instances"
3461 summary: Execute an action on a NetSlice instance
3463 Execute an action on a NetSlice instance.
3464 The NetSlice instance must have been created and must be in INSTANTIATED state.
3465 operationId: actionOnNSI
3470 $ref: '#/components/schemas/NsiActionRequest'
3473 $ref: '#/components/schemas/NsiActionRequest'
3476 description: Accepted
3480 It must point to the new "NS Lifecycle Operation Occurrence"
3481 resource, i.e. an URI like ".../ns_lcm_op_occs/{nsLcmOpOccId}"
3488 $ref: '#/components/schemas/ObjectId'
3491 $ref: '#/components/schemas/ObjectId'
3493 $ref: '#/components/responses/BadRequest'
3495 $ref: '#/components/responses/Unauthorized'
3497 $ref: '#/components/responses/Forbidden'
3499 $ref: '#/components/responses/NotFound'
3501 $ref: '#/components/responses/MethodNotAllowed'
3503 $ref: '#/components/responses/NotAcceptable'
3505 $ref: '#/components/responses/Conflict'
3507 $ref: '#/components/responses/UnprocessableEntity'
3509 $ref: '#/components/responses/InternalServerError'
3511 $ref: '#/components/responses/ServiceUnavailable'
3513 $ref: '#/components/responses/UnexpectedError'
3515 $ref: '#/components/responses/UnexpectedError'
3516 '/nsilcm/v1/netslice_instances_content':
3519 - "NetSlice instances"
3520 summary: Query information about multiple NetSlice instances
3521 description: Query information about multiple NetSlice isntances
3522 operationId: getNSIsContent
3529 $ref: '#/components/schemas/ArrayOfNetSliceInstance'
3532 $ref: '#/components/schemas/ArrayOfNetSliceInstance'
3534 $ref: '#/components/responses/BadRequest'
3536 $ref: '#/components/responses/Unauthorized'
3538 $ref: '#/components/responses/Forbidden'
3540 $ref: '#/components/responses/NotFound'
3542 $ref: '#/components/responses/MethodNotAllowed'
3544 $ref: '#/components/responses/NotAcceptable'
3546 $ref: '#/components/responses/Conflict'
3548 $ref: '#/components/responses/UnprocessableEntity'
3550 $ref: '#/components/responses/InternalServerError'
3552 $ref: '#/components/responses/ServiceUnavailable'
3554 $ref: '#/components/responses/UnexpectedError'
3556 $ref: '#/components/responses/UnexpectedError'
3559 - "NetSlice instances"
3560 summary: Create a new NetSlice instance
3561 description: Create a new NetSlice instance
3562 operationId: createNSIContent
3564 $ref: '#/components/requestBodies/InstantiateNsiRequest'
3567 description: Created
3576 $ref: '#/components/schemas/CreateNsiContentResponse'
3579 $ref: '#/components/schemas/CreateNsiContentResponse'
3581 $ref: '#/components/responses/BadRequest'
3583 $ref: '#/components/responses/Unauthorized'
3585 $ref: '#/components/responses/Forbidden'
3587 $ref: '#/components/responses/NotFound'
3589 $ref: '#/components/responses/MethodNotAllowed'
3591 $ref: '#/components/responses/NotAcceptable'
3593 $ref: '#/components/responses/Conflict'
3595 $ref: '#/components/responses/UnprocessableEntity'
3597 $ref: '#/components/responses/InternalServerError'
3599 $ref: '#/components/responses/ServiceUnavailable'
3601 $ref: '#/components/responses/UnexpectedError'
3603 $ref: '#/components/responses/UnexpectedError'
3604 '/nsilcm/v1/netslice_instances_content/{netsliceInstanceContentId}':
3606 - name: netsliceInstanceContentId
3609 description: NetSlice Instance Content ID
3614 - "NetSlice instances"
3615 summary: Read an individual NetSlice instance resource
3616 description: Read an individual NetSlice instance resource
3617 operationId: getNSIContent
3624 $ref: '#/components/schemas/NetSliceInstance'
3627 $ref: '#/components/schemas/NetSliceInstance'
3629 $ref: '#/components/responses/BadRequest'
3631 $ref: '#/components/responses/Unauthorized'
3633 $ref: '#/components/responses/Forbidden'
3635 $ref: '#/components/responses/NotFound'
3637 $ref: '#/components/responses/MethodNotAllowed'
3639 $ref: '#/components/responses/NotAcceptable'
3641 $ref: '#/components/responses/Conflict'
3643 $ref: '#/components/responses/UnprocessableEntity'
3645 $ref: '#/components/responses/InternalServerError'
3647 $ref: '#/components/responses/ServiceUnavailable'
3649 $ref: '#/components/responses/UnexpectedError'
3651 $ref: '#/components/responses/UnexpectedError'
3654 - "NetSlice instances"
3655 summary: Delete an individual NS instance resource
3656 description: Delete an individual NS instance resource
3657 operationId: deleteNSIContent
3660 description: Accepted
3664 $ref: '#/components/schemas/ObjectId'
3667 $ref: '#/components/schemas/ObjectId'
3669 description: No Content
3671 $ref: '#/components/responses/BadRequest'
3673 $ref: '#/components/responses/Unauthorized'
3675 $ref: '#/components/responses/Forbidden'
3677 $ref: '#/components/responses/NotFound'
3679 $ref: '#/components/responses/MethodNotAllowed'
3681 $ref: '#/components/responses/NotAcceptable'
3683 $ref: '#/components/responses/Conflict'
3685 $ref: '#/components/responses/UnprocessableEntity'
3687 $ref: '#/components/responses/InternalServerError'
3689 $ref: '#/components/responses/ServiceUnavailable'
3691 $ref: '#/components/responses/UnexpectedError'
3693 $ref: '#/components/responses/UnexpectedError'
3694 '/nsilcm/v1/nsi_lcm_op_occs':
3697 - "NetSlice instances"
3698 summary: Query information about multiple NetSlice LCM Operation Occurrences
3699 description: Query information about multiple NetSlice LCM Operation Occurrences
3700 operationId: getNsiLcmOpOccs
3707 $ref: '#/components/schemas/ArrayOfNsiLcmOpOcc'
3710 $ref: '#/components/schemas/ArrayOfNsiLcmOpOcc'
3712 $ref: '#/components/responses/BadRequest'
3714 $ref: '#/components/responses/Unauthorized'
3716 $ref: '#/components/responses/Forbidden'
3718 $ref: '#/components/responses/NotFound'
3720 $ref: '#/components/responses/MethodNotAllowed'
3722 $ref: '#/components/responses/NotAcceptable'
3724 $ref: '#/components/responses/Conflict'
3726 $ref: '#/components/responses/UnprocessableEntity'
3728 $ref: '#/components/responses/InternalServerError'
3730 $ref: '#/components/responses/ServiceUnavailable'
3732 $ref: '#/components/responses/UnexpectedError'
3734 $ref: '#/components/responses/UnexpectedError'
3735 '/nsilcm/v1/nsi_lcm_op_occs/{nsiLcmOpOccId}':
3737 - name: nsiLcmOpOccId
3740 description: NetSlice LCM Operation Occurrence ID
3745 - "NetSlice instances"
3746 summary: Query information about an individual NetSlice LCM Operation Occurrence
3747 description: Query information about an individual NetSlice LCM Operation Occurrence
3748 operationId: getNsiLcmOpOcc
3755 $ref: '#/components/schemas/NsiLcmOpOcc'
3758 $ref: '#/components/schemas/NsiLcmOpOcc'
3760 $ref: '#/components/responses/BadRequest'
3762 $ref: '#/components/responses/Unauthorized'
3764 $ref: '#/components/responses/Forbidden'
3766 $ref: '#/components/responses/NotFound'
3768 $ref: '#/components/responses/MethodNotAllowed'
3770 $ref: '#/components/responses/NotAcceptable'
3772 $ref: '#/components/responses/Conflict'
3774 $ref: '#/components/responses/UnprocessableEntity'
3776 $ref: '#/components/responses/InternalServerError'
3778 $ref: '#/components/responses/ServiceUnavailable'
3780 $ref: '#/components/responses/UnexpectedError'
3782 $ref: '#/components/responses/UnexpectedError'
3783 # END NetSlice Instances
3786 '/nspm/v1/pm_jobs/{pmJobId}/reports/{nsId}':
3791 description: NS PM Job ID
3802 - "NS Performance Management"
3803 summary: Query information about an individual NS PM Job Report
3804 description: Query information about an individual NS PM Job Report
3805 operationId: getNsPmJobReport
3812 $ref: '#/components/schemas/NsPmJobReportInfo'
3815 $ref: '#/components/schemas/NsPmJobReportInfo'
3817 $ref: '#/components/responses/BadRequest'
3819 $ref: '#/components/responses/Unauthorized'
3821 $ref: '#/components/responses/Forbidden'
3823 $ref: '#/components/responses/NotFound'
3825 $ref: '#/components/responses/MethodNotAllowed'
3827 $ref: '#/components/responses/NotAcceptable'
3829 $ref: '#/components/responses/Conflict'
3831 $ref: '#/components/responses/UnprocessableEntity'
3833 $ref: '#/components/responses/InternalServerError'
3835 $ref: '#/components/responses/ServiceUnavailable'
3837 $ref: '#/components/responses/UnexpectedError'
3839 $ref: '#/components/responses/UnexpectedError'
3843 '/pdu/v1/pdu_descriptors':
3846 - "Physical Data Units (PDU)"
3847 summary: Query information about multiple PDU Descriptors
3848 description: Query information about multiple PDU Descriptors
3849 operationId: getPDUs
3856 $ref: '#/components/schemas/ArrayOfPduInfo'
3859 $ref: '#/components/schemas/ArrayOfPduInfo'
3861 $ref: '#/components/responses/BadRequest'
3863 $ref: '#/components/responses/Unauthorized'
3865 $ref: '#/components/responses/Forbidden'
3867 $ref: '#/components/responses/NotFound'
3869 $ref: '#/components/responses/MethodNotAllowed'
3871 $ref: '#/components/responses/NotAcceptable'
3873 $ref: '#/components/responses/Conflict'
3875 $ref: '#/components/responses/UnprocessableEntity'
3877 $ref: '#/components/responses/InternalServerError'
3879 $ref: '#/components/responses/ServiceUnavailable'
3881 $ref: '#/components/responses/UnexpectedError'
3883 $ref: '#/components/responses/UnexpectedError'
3886 - "Physical Data Units (PDU)"
3887 summary: Create a new PDU
3888 description: Create a new PDU Descriptor
3889 operationId: createPDU
3891 $ref: '#/components/requestBodies/CreatePduRequest'
3903 $ref: '#/components/schemas/ObjectId'
3906 $ref: '#/components/schemas/ObjectId'
3908 $ref: '#/components/responses/BadRequest'
3910 $ref: '#/components/responses/Unauthorized'
3912 $ref: '#/components/responses/Forbidden'
3914 $ref: '#/components/responses/NotFound'
3916 $ref: '#/components/responses/MethodNotAllowed'
3918 $ref: '#/components/responses/NotAcceptable'
3920 $ref: '#/components/responses/Conflict'
3922 $ref: '#/components/responses/UnprocessableEntity'
3924 $ref: '#/components/responses/InternalServerError'
3926 $ref: '#/components/responses/ServiceUnavailable'
3928 $ref: '#/components/responses/UnexpectedError'
3930 $ref: '#/components/responses/UnexpectedError'
3931 '/pdu/v1/pdu_descriptors/{pduDescriptorId}':
3933 - name: pduDescriptorId
3936 description: PDU Descriptor ID
3941 - "Physical Data Units (PDU)"
3942 summary: Query information about an individual PDU Descriptor
3943 description: Query information about an individual PDU Descriptor
3951 $ref: '#/components/schemas/PduInfo'
3954 $ref: '#/components/schemas/PduInfo'
3956 $ref: '#/components/responses/BadRequest'
3958 $ref: '#/components/responses/Unauthorized'
3960 $ref: '#/components/responses/Forbidden'
3962 $ref: '#/components/responses/NotFound'
3964 $ref: '#/components/responses/MethodNotAllowed'
3966 $ref: '#/components/responses/NotAcceptable'
3968 $ref: '#/components/responses/Conflict'
3970 $ref: '#/components/responses/UnprocessableEntity'
3972 $ref: '#/components/responses/InternalServerError'
3974 $ref: '#/components/responses/ServiceUnavailable'
3976 $ref: '#/components/responses/UnexpectedError'
3978 $ref: '#/components/responses/UnexpectedError'
3981 - "Physical Data Units (PDU)"
3982 summary: Modify an individual PDU Descriptor
3983 description: Modify an individual PDU Descriptor
3984 operationId: editPDU
3986 $ref: '#/components/requestBodies/EditPduRequest'
3989 description: No Content
3991 $ref: '#/components/responses/BadRequest'
3993 $ref: '#/components/responses/Unauthorized'
3995 $ref: '#/components/responses/Forbidden'
3997 $ref: '#/components/responses/NotFound'
3999 $ref: '#/components/responses/MethodNotAllowed'
4001 $ref: '#/components/responses/NotAcceptable'
4003 $ref: '#/components/responses/Conflict'
4005 $ref: '#/components/responses/UnprocessableEntity'
4007 $ref: '#/components/responses/InternalServerError'
4009 $ref: '#/components/responses/ServiceUnavailable'
4011 $ref: '#/components/responses/UnexpectedError'
4013 $ref: '#/components/responses/UnexpectedError'
4016 - "Physical Data Units (PDU)"
4017 summary: Delete an individual PDU Descriptor
4018 description: Delete an individual PDU Descriptor
4019 operationId: deletePDU
4022 description: No Content
4024 $ref: '#/components/responses/BadRequest'
4026 $ref: '#/components/responses/Unauthorized'
4028 $ref: '#/components/responses/Forbidden'
4030 $ref: '#/components/responses/NotFound'
4032 $ref: '#/components/responses/MethodNotAllowed'
4034 $ref: '#/components/responses/NotAcceptable'
4036 $ref: '#/components/responses/Conflict'
4038 $ref: '#/components/responses/UnprocessableEntity'
4040 $ref: '#/components/responses/InternalServerError'
4042 $ref: '#/components/responses/ServiceUnavailable'
4044 $ref: '#/components/responses/UnexpectedError'
4046 $ref: '#/components/responses/UnexpectedError'
4055 summary: Query information about multiple Tokens
4056 description: Query information about multiple Tokens
4057 operationId: getTokens
4064 $ref: '#/components/schemas/ArrayOfTokenInfo'
4067 $ref: '#/components/schemas/ArrayOfTokenInfo'
4069 $ref: '#/components/responses/BadRequest'
4071 $ref: '#/components/responses/Unauthorized'
4073 $ref: '#/components/responses/Forbidden'
4075 $ref: '#/components/responses/NotFound'
4077 $ref: '#/components/responses/MethodNotAllowed'
4079 $ref: '#/components/responses/NotAcceptable'
4081 $ref: '#/components/responses/Conflict'
4083 $ref: '#/components/responses/UnprocessableEntity'
4085 $ref: '#/components/responses/InternalServerError'
4087 $ref: '#/components/responses/ServiceUnavailable'
4089 $ref: '#/components/responses/UnexpectedError'
4091 $ref: '#/components/responses/UnexpectedError'
4096 summary: Request a new Token
4097 description: Request a new Token
4098 operationId: createToken
4100 $ref: '#/components/requestBodies/CreateTokenRequest'
4113 - $ref: '#/components/schemas/TokenInfo'
4114 - $ref: '#/components/schemas/PasswordExpiryInfo'
4118 - $ref: '#/components/schemas/TokenInfo'
4119 - $ref: '#/components/schemas/PasswordExpiryInfo'
4121 $ref: '#/components/responses/BadRequest'
4123 $ref: '#/components/responses/Unauthorized'
4125 $ref: '#/components/responses/Forbidden'
4127 $ref: '#/components/responses/NotFound'
4129 $ref: '#/components/responses/MethodNotAllowed'
4131 $ref: '#/components/responses/NotAcceptable'
4133 $ref: '#/components/responses/Conflict'
4135 $ref: '#/components/responses/UnprocessableEntity'
4137 $ref: '#/components/responses/InternalServerError'
4139 $ref: '#/components/responses/ServiceUnavailable'
4141 $ref: '#/components/responses/UnexpectedError'
4143 $ref: '#/components/responses/UnexpectedError'
4148 summary: Delete the Token indicated in the Authorization Header
4149 description: Delete the Token indicated in the Authorization Header
4150 operationId: deleteAuthToken
4162 $ref: '#/components/responses/BadRequest'
4164 $ref: '#/components/responses/Unauthorized'
4166 $ref: '#/components/responses/Forbidden'
4168 $ref: '#/components/responses/NotFound'
4170 $ref: '#/components/responses/MethodNotAllowed'
4172 $ref: '#/components/responses/NotAcceptable'
4174 $ref: '#/components/responses/Conflict'
4176 $ref: '#/components/responses/UnprocessableEntity'
4178 $ref: '#/components/responses/InternalServerError'
4180 $ref: '#/components/responses/ServiceUnavailable'
4182 $ref: '#/components/responses/UnexpectedError'
4184 $ref: '#/components/responses/UnexpectedError'
4185 '/admin/v1/tokens/{tokenId}':
4190 description: Token ID
4197 summary: Query information about an individual Token
4198 description: Query information about an individual Token
4199 operationId: getToken
4206 $ref: '#/components/schemas/TokenInfo'
4209 $ref: '#/components/schemas/TokenInfo'
4211 $ref: '#/components/responses/BadRequest'
4213 $ref: '#/components/responses/Unauthorized'
4215 $ref: '#/components/responses/Forbidden'
4217 $ref: '#/components/responses/NotFound'
4219 $ref: '#/components/responses/MethodNotAllowed'
4221 $ref: '#/components/responses/NotAcceptable'
4223 $ref: '#/components/responses/Conflict'
4225 $ref: '#/components/responses/UnprocessableEntity'
4227 $ref: '#/components/responses/InternalServerError'
4229 $ref: '#/components/responses/ServiceUnavailable'
4231 $ref: '#/components/responses/UnexpectedError'
4233 $ref: '#/components/responses/UnexpectedError'
4238 summary: Delete the Token indicated as parameter
4239 description: Delete the Token indicated as parameter
4240 operationId: deleteToken
4252 $ref: '#/components/responses/BadRequest'
4254 $ref: '#/components/responses/Unauthorized'
4256 $ref: '#/components/responses/Forbidden'
4258 $ref: '#/components/responses/NotFound'
4260 $ref: '#/components/responses/MethodNotAllowed'
4262 $ref: '#/components/responses/NotAcceptable'
4264 $ref: '#/components/responses/Conflict'
4266 $ref: '#/components/responses/UnprocessableEntity'
4268 $ref: '#/components/responses/InternalServerError'
4270 $ref: '#/components/responses/ServiceUnavailable'
4272 $ref: '#/components/responses/UnexpectedError'
4274 $ref: '#/components/responses/UnexpectedError'
4280 summary: Query information about multiple Users
4281 description: Query information about multiple Users
4282 operationId: getUsers
4289 $ref: '#/components/schemas/ArrayOfUserInfo'
4292 $ref: '#/components/schemas/ArrayOfUserInfo'
4294 $ref: '#/components/responses/BadRequest'
4296 $ref: '#/components/responses/Unauthorized'
4298 $ref: '#/components/responses/Forbidden'
4300 $ref: '#/components/responses/NotFound'
4302 $ref: '#/components/responses/MethodNotAllowed'
4304 $ref: '#/components/responses/NotAcceptable'
4306 $ref: '#/components/responses/Conflict'
4308 $ref: '#/components/responses/UnprocessableEntity'
4310 $ref: '#/components/responses/InternalServerError'
4312 $ref: '#/components/responses/ServiceUnavailable'
4314 $ref: '#/components/responses/UnexpectedError'
4316 $ref: '#/components/responses/UnexpectedError'
4321 summary: Create a new User
4322 description: Create a new User
4323 operationId: createUser
4325 $ref: '#/components/requestBodies/CreateUserRequest'
4328 description: Created
4337 $ref: '#/components/schemas/ObjectId'
4340 $ref: '#/components/schemas/ObjectId'
4342 $ref: '#/components/responses/BadRequest'
4344 $ref: '#/components/responses/Unauthorized'
4346 $ref: '#/components/responses/Forbidden'
4348 $ref: '#/components/responses/NotFound'
4350 $ref: '#/components/responses/MethodNotAllowed'
4352 $ref: '#/components/responses/NotAcceptable'
4354 $ref: '#/components/responses/Conflict'
4356 $ref: '#/components/responses/UnprocessableEntity'
4358 $ref: '#/components/responses/InternalServerError'
4360 $ref: '#/components/responses/ServiceUnavailable'
4362 $ref: '#/components/responses/UnexpectedError'
4364 $ref: '#/components/responses/UnexpectedError'
4365 '/admin/v1/users/{userId}':
4370 description: User ID/Name
4377 summary: Query information about an individual User
4378 description: Query information about an individual User
4379 operationId: getUser
4386 $ref: '#/components/schemas/UserInfo'
4389 $ref: '#/components/schemas/UserInfo'
4391 $ref: '#/components/responses/BadRequest'
4393 $ref: '#/components/responses/Unauthorized'
4395 $ref: '#/components/responses/Forbidden'
4397 $ref: '#/components/responses/NotFound'
4399 $ref: '#/components/responses/MethodNotAllowed'
4401 $ref: '#/components/responses/NotAcceptable'
4403 $ref: '#/components/responses/Conflict'
4405 $ref: '#/components/responses/UnprocessableEntity'
4407 $ref: '#/components/responses/InternalServerError'
4409 $ref: '#/components/responses/ServiceUnavailable'
4411 $ref: '#/components/responses/UnexpectedError'
4413 $ref: '#/components/responses/UnexpectedError'
4418 summary: Modify a User
4419 description: Modify a User
4420 operationId: editUser
4422 $ref: '#/components/requestBodies/EditUserRequest'
4425 description: No Content
4427 $ref: '#/components/responses/BadRequest'
4429 $ref: '#/components/responses/Unauthorized'
4431 $ref: '#/components/responses/Forbidden'
4433 $ref: '#/components/responses/NotFound'
4435 $ref: '#/components/responses/MethodNotAllowed'
4437 $ref: '#/components/responses/NotAcceptable'
4439 $ref: '#/components/responses/Conflict'
4441 $ref: '#/components/responses/UnprocessableEntity'
4443 $ref: '#/components/responses/InternalServerError'
4445 $ref: '#/components/responses/ServiceUnavailable'
4447 $ref: '#/components/responses/UnexpectedError'
4449 $ref: '#/components/responses/UnexpectedError'
4454 summary: Delete a User
4455 description: Delete a User
4456 operationId: deleteUser
4459 description: No Content
4461 $ref: '#/components/responses/BadRequest'
4463 $ref: '#/components/responses/Unauthorized'
4465 $ref: '#/components/responses/Forbidden'
4467 $ref: '#/components/responses/NotFound'
4469 $ref: '#/components/responses/MethodNotAllowed'
4471 $ref: '#/components/responses/NotAcceptable'
4473 $ref: '#/components/responses/Conflict'
4475 $ref: '#/components/responses/UnprocessableEntity'
4477 $ref: '#/components/responses/InternalServerError'
4479 $ref: '#/components/responses/ServiceUnavailable'
4481 $ref: '#/components/responses/UnexpectedError'
4483 $ref: '#/components/responses/UnexpectedError'
4484 '/admin/v1/projects':
4489 summary: Query information about multiple Projects
4490 description: Query information about multiple Projects
4491 operationId: getProjects
4498 $ref: '#/components/schemas/ArrayOfProjectInfo'
4501 $ref: '#/components/schemas/ArrayOfProjectInfo'
4503 $ref: '#/components/responses/BadRequest'
4505 $ref: '#/components/responses/Unauthorized'
4507 $ref: '#/components/responses/Forbidden'
4509 $ref: '#/components/responses/NotFound'
4511 $ref: '#/components/responses/MethodNotAllowed'
4513 $ref: '#/components/responses/NotAcceptable'
4515 $ref: '#/components/responses/Conflict'
4517 $ref: '#/components/responses/UnprocessableEntity'
4519 $ref: '#/components/responses/InternalServerError'
4521 $ref: '#/components/responses/ServiceUnavailable'
4523 $ref: '#/components/responses/UnexpectedError'
4525 $ref: '#/components/responses/UnexpectedError'
4530 summary: Create a new Project
4531 description: Create a new Project
4532 operationId: createProject
4534 $ref: '#/components/requestBodies/CreateProjectRequest'
4537 description: Created
4546 $ref: '#/components/schemas/ObjectId'
4549 $ref: '#/components/schemas/ObjectId'
4551 $ref: '#/components/responses/BadRequest'
4553 $ref: '#/components/responses/Unauthorized'
4555 $ref: '#/components/responses/Forbidden'
4557 $ref: '#/components/responses/NotFound'
4559 $ref: '#/components/responses/MethodNotAllowed'
4561 $ref: '#/components/responses/NotAcceptable'
4563 $ref: '#/components/responses/Conflict'
4565 $ref: '#/components/responses/UnprocessableEntity'
4567 $ref: '#/components/responses/InternalServerError'
4569 $ref: '#/components/responses/ServiceUnavailable'
4571 $ref: '#/components/responses/UnexpectedError'
4573 $ref: '#/components/responses/UnexpectedError'
4574 '/admin/v1/projects/{projectId}':
4579 description: Project ID/Name
4586 summary: Query information about an individual Project
4587 description: Query information about an individual Project
4588 operationId: getProject
4595 $ref: '#/components/schemas/ProjectInfo'
4598 $ref: '#/components/schemas/ProjectInfo'
4600 $ref: '#/components/responses/BadRequest'
4602 $ref: '#/components/responses/Unauthorized'
4604 $ref: '#/components/responses/Forbidden'
4606 $ref: '#/components/responses/NotFound'
4608 $ref: '#/components/responses/MethodNotAllowed'
4610 $ref: '#/components/responses/NotAcceptable'
4612 $ref: '#/components/responses/Conflict'
4614 $ref: '#/components/responses/UnprocessableEntity'
4616 $ref: '#/components/responses/InternalServerError'
4618 $ref: '#/components/responses/ServiceUnavailable'
4620 $ref: '#/components/responses/UnexpectedError'
4622 $ref: '#/components/responses/UnexpectedError'
4627 summary: Modify a Project
4628 description: Modify a Project
4629 operationId: editProject
4631 $ref: '#/components/requestBodies/EditProjectRequest'
4634 description: No Content
4636 $ref: '#/components/responses/BadRequest'
4638 $ref: '#/components/responses/Unauthorized'
4640 $ref: '#/components/responses/Forbidden'
4642 $ref: '#/components/responses/NotFound'
4644 $ref: '#/components/responses/MethodNotAllowed'
4646 $ref: '#/components/responses/NotAcceptable'
4648 $ref: '#/components/responses/Conflict'
4650 $ref: '#/components/responses/UnprocessableEntity'
4652 $ref: '#/components/responses/InternalServerError'
4654 $ref: '#/components/responses/ServiceUnavailable'
4656 $ref: '#/components/responses/UnexpectedError'
4658 $ref: '#/components/responses/UnexpectedError'
4663 summary: Delete a Project
4664 description: Delete a Project
4665 operationId: deleteProject
4668 description: No Content
4670 $ref: '#/components/responses/BadRequest'
4672 $ref: '#/components/responses/Unauthorized'
4674 $ref: '#/components/responses/Forbidden'
4676 $ref: '#/components/responses/NotFound'
4678 $ref: '#/components/responses/MethodNotAllowed'
4680 $ref: '#/components/responses/NotAcceptable'
4682 $ref: '#/components/responses/Conflict'
4684 $ref: '#/components/responses/UnprocessableEntity'
4686 $ref: '#/components/responses/InternalServerError'
4688 $ref: '#/components/responses/ServiceUnavailable'
4690 $ref: '#/components/responses/UnexpectedError'
4692 $ref: '#/components/responses/UnexpectedError'
4698 summary: Query information about multiple Roles
4699 description: Query information about multiple Roles
4700 operationId: getRoles
4707 $ref: '#/components/schemas/ArrayOfRoleInfo'
4710 $ref: '#/components/schemas/ArrayOfRoleInfo'
4712 $ref: '#/components/responses/BadRequest'
4714 $ref: '#/components/responses/Unauthorized'
4716 $ref: '#/components/responses/Forbidden'
4718 $ref: '#/components/responses/NotFound'
4720 $ref: '#/components/responses/MethodNotAllowed'
4722 $ref: '#/components/responses/NotAcceptable'
4724 $ref: '#/components/responses/Conflict'
4726 $ref: '#/components/responses/UnprocessableEntity'
4728 $ref: '#/components/responses/InternalServerError'
4730 $ref: '#/components/responses/ServiceUnavailable'
4732 $ref: '#/components/responses/UnexpectedError'
4734 $ref: '#/components/responses/UnexpectedError'
4739 summary: Create a new Role
4740 description: Create a new Role
4741 operationId: createRole
4743 $ref: '#/components/requestBodies/CreateRoleRequest'
4746 description: Created
4755 $ref: '#/components/schemas/ObjectId'
4758 $ref: '#/components/schemas/ObjectId'
4760 $ref: '#/components/responses/BadRequest'
4762 $ref: '#/components/responses/Unauthorized'
4764 $ref: '#/components/responses/Forbidden'
4766 $ref: '#/components/responses/NotFound'
4768 $ref: '#/components/responses/MethodNotAllowed'
4770 $ref: '#/components/responses/NotAcceptable'
4772 $ref: '#/components/responses/Conflict'
4774 $ref: '#/components/responses/UnprocessableEntity'
4776 $ref: '#/components/responses/InternalServerError'
4778 $ref: '#/components/responses/ServiceUnavailable'
4780 $ref: '#/components/responses/UnexpectedError'
4782 $ref: '#/components/responses/UnexpectedError'
4783 '/admin/v1/roles/{roleId}':
4788 description: Role ID/Name
4795 summary: Query information about an individual Role
4796 description: Query information about an individual Role
4797 operationId: getRole
4804 $ref: '#/components/schemas/RoleInfo'
4807 $ref: '#/components/schemas/RoleInfo'
4809 $ref: '#/components/responses/BadRequest'
4811 $ref: '#/components/responses/Unauthorized'
4813 $ref: '#/components/responses/Forbidden'
4815 $ref: '#/components/responses/NotFound'
4817 $ref: '#/components/responses/MethodNotAllowed'
4819 $ref: '#/components/responses/NotAcceptable'
4821 $ref: '#/components/responses/Conflict'
4823 $ref: '#/components/responses/UnprocessableEntity'
4825 $ref: '#/components/responses/InternalServerError'
4827 $ref: '#/components/responses/ServiceUnavailable'
4829 $ref: '#/components/responses/UnexpectedError'
4831 $ref: '#/components/responses/UnexpectedError'
4836 summary: Modify a Role
4837 description: Modify a Role
4838 operationId: editRole
4840 $ref: '#/components/requestBodies/EditRoleRequest'
4843 description: No Content
4845 $ref: '#/components/responses/BadRequest'
4847 $ref: '#/components/responses/Unauthorized'
4849 $ref: '#/components/responses/Forbidden'
4851 $ref: '#/components/responses/NotFound'
4853 $ref: '#/components/responses/MethodNotAllowed'
4855 $ref: '#/components/responses/NotAcceptable'
4857 $ref: '#/components/responses/Conflict'
4859 $ref: '#/components/responses/UnprocessableEntity'
4861 $ref: '#/components/responses/InternalServerError'
4863 $ref: '#/components/responses/ServiceUnavailable'
4865 $ref: '#/components/responses/UnexpectedError'
4867 $ref: '#/components/responses/UnexpectedError'
4872 summary: Delete a Role
4873 description: Delete a Role
4874 operationId: deleteRole
4877 description: No Content
4879 $ref: '#/components/responses/BadRequest'
4881 $ref: '#/components/responses/Unauthorized'
4883 $ref: '#/components/responses/Forbidden'
4885 $ref: '#/components/responses/NotFound'
4887 $ref: '#/components/responses/MethodNotAllowed'
4889 $ref: '#/components/responses/NotAcceptable'
4891 $ref: '#/components/responses/Conflict'
4893 $ref: '#/components/responses/UnprocessableEntity'
4895 $ref: '#/components/responses/InternalServerError'
4897 $ref: '#/components/responses/ServiceUnavailable'
4899 $ref: '#/components/responses/UnexpectedError'
4901 $ref: '#/components/responses/UnexpectedError'
4907 summary: Query information about multiple VIMs
4908 description: Query information about multiple VIMs
4909 operationId: getVIMs
4916 $ref: '#/components/schemas/ArrayOfVimInfo'
4919 $ref: '#/components/schemas/ArrayOfVimInfo'
4921 $ref: '#/components/responses/BadRequest'
4923 $ref: '#/components/responses/Unauthorized'
4925 $ref: '#/components/responses/Forbidden'
4927 $ref: '#/components/responses/NotFound'
4929 $ref: '#/components/responses/MethodNotAllowed'
4931 $ref: '#/components/responses/NotAcceptable'
4933 $ref: '#/components/responses/Conflict'
4935 $ref: '#/components/responses/UnprocessableEntity'
4937 $ref: '#/components/responses/InternalServerError'
4939 $ref: '#/components/responses/ServiceUnavailable'
4941 $ref: '#/components/responses/UnexpectedError'
4943 $ref: '#/components/responses/UnexpectedError'
4948 summary: Create a new VIM
4949 description: Create a new VIM
4950 operationId: createVIM
4952 $ref: '#/components/requestBodies/CreateVimRequest'
4955 description: Accepted
4959 $ref: '#/components/schemas/ObjectId_plus_OpId'
4962 $ref: '#/components/schemas/ObjectId_plus_OpId'
4964 $ref: '#/components/responses/BadRequest'
4966 $ref: '#/components/responses/Unauthorized'
4968 $ref: '#/components/responses/Forbidden'
4970 $ref: '#/components/responses/NotFound'
4972 $ref: '#/components/responses/MethodNotAllowed'
4974 $ref: '#/components/responses/NotAcceptable'
4976 $ref: '#/components/responses/Conflict'
4978 $ref: '#/components/responses/UnprocessableEntity'
4980 $ref: '#/components/responses/InternalServerError'
4982 $ref: '#/components/responses/ServiceUnavailable'
4984 $ref: '#/components/responses/UnexpectedError'
4986 $ref: '#/components/responses/UnexpectedError'
4987 '/admin/v1/vims/{vimId}':
5000 summary: Query information about an individual VIM
5001 description: Query information about an individual VIM
5009 $ref: '#/components/schemas/VimInfo'
5012 $ref: '#/components/schemas/VimInfo'
5014 $ref: '#/components/responses/BadRequest'
5016 $ref: '#/components/responses/Unauthorized'
5018 $ref: '#/components/responses/Forbidden'
5020 $ref: '#/components/responses/NotFound'
5022 $ref: '#/components/responses/MethodNotAllowed'
5024 $ref: '#/components/responses/NotAcceptable'
5026 $ref: '#/components/responses/Conflict'
5028 $ref: '#/components/responses/UnprocessableEntity'
5030 $ref: '#/components/responses/InternalServerError'
5032 $ref: '#/components/responses/ServiceUnavailable'
5034 $ref: '#/components/responses/UnexpectedError'
5036 $ref: '#/components/responses/UnexpectedError'
5041 summary: Modify a VIM
5042 description: Modify a VIM
5043 operationId: editVIM
5045 $ref: '#/components/requestBodies/EditVimRequest'
5048 description: Accepted
5052 $ref: '#/components/schemas/OpId'
5055 $ref: '#/components/schemas/OpId'
5057 $ref: '#/components/responses/BadRequest'
5059 $ref: '#/components/responses/Unauthorized'
5061 $ref: '#/components/responses/Forbidden'
5063 $ref: '#/components/responses/NotFound'
5065 $ref: '#/components/responses/MethodNotAllowed'
5067 $ref: '#/components/responses/NotAcceptable'
5069 $ref: '#/components/responses/Conflict'
5071 $ref: '#/components/responses/UnprocessableEntity'
5073 $ref: '#/components/responses/InternalServerError'
5075 $ref: '#/components/responses/ServiceUnavailable'
5077 $ref: '#/components/responses/UnexpectedError'
5079 $ref: '#/components/responses/UnexpectedError'
5084 summary: Delete a VIM
5085 description: Delete a VIM
5086 operationId: deleteVIM
5089 description: Accepted
5091 $ref: '#/components/responses/BadRequest'
5093 $ref: '#/components/responses/Unauthorized'
5095 $ref: '#/components/responses/Forbidden'
5097 $ref: '#/components/responses/NotFound'
5099 $ref: '#/components/responses/MethodNotAllowed'
5101 $ref: '#/components/responses/NotAcceptable'
5103 $ref: '#/components/responses/Conflict'
5105 $ref: '#/components/responses/UnprocessableEntity'
5107 $ref: '#/components/responses/InternalServerError'
5109 $ref: '#/components/responses/ServiceUnavailable'
5111 $ref: '#/components/responses/UnexpectedError'
5113 $ref: '#/components/responses/UnexpectedError'
5114 '/admin/v1/vim_accounts':
5119 summary: Query information about multiple VIM Accounts
5120 description: Query information about multiple VIM Accounts
5121 operationId: getVimAccounts
5128 $ref: '#/components/schemas/ArrayOfVimInfo'
5131 $ref: '#/components/schemas/ArrayOfVimInfo'
5133 $ref: '#/components/responses/BadRequest'
5135 $ref: '#/components/responses/Unauthorized'
5137 $ref: '#/components/responses/Forbidden'
5139 $ref: '#/components/responses/NotFound'
5141 $ref: '#/components/responses/MethodNotAllowed'
5143 $ref: '#/components/responses/NotAcceptable'
5145 $ref: '#/components/responses/Conflict'
5147 $ref: '#/components/responses/UnprocessableEntity'
5149 $ref: '#/components/responses/InternalServerError'
5151 $ref: '#/components/responses/ServiceUnavailable'
5153 $ref: '#/components/responses/UnexpectedError'
5155 $ref: '#/components/responses/UnexpectedError'
5160 summary: Create a new VIM Account
5161 description: Create a new VIM Account
5162 operationId: createVimAccount
5164 $ref: '#/components/requestBodies/CreateVimRequest'
5167 description: Accepted
5171 $ref: '#/components/schemas/ObjectId_plus_OpId'
5174 $ref: '#/components/schemas/ObjectId_plus_OpId'
5176 $ref: '#/components/responses/BadRequest'
5178 $ref: '#/components/responses/Unauthorized'
5180 $ref: '#/components/responses/Forbidden'
5182 $ref: '#/components/responses/NotFound'
5184 $ref: '#/components/responses/MethodNotAllowed'
5186 $ref: '#/components/responses/NotAcceptable'
5188 $ref: '#/components/responses/Conflict'
5190 $ref: '#/components/responses/UnprocessableEntity'
5192 $ref: '#/components/responses/InternalServerError'
5194 $ref: '#/components/responses/ServiceUnavailable'
5196 $ref: '#/components/responses/UnexpectedError'
5198 $ref: '#/components/responses/UnexpectedError'
5199 '/admin/v1/vim_accounts/{vimAccountId}':
5201 - name: vimAccountId
5204 description: VIM Account ID
5212 summary: Query information about an individual VIM Account
5213 description: Query information about an individual VIM Account
5214 operationId: getVimAccount
5221 $ref: '#/components/schemas/VimInfo'
5224 $ref: '#/components/schemas/VimInfo'
5226 $ref: '#/components/responses/BadRequest'
5228 $ref: '#/components/responses/Unauthorized'
5230 $ref: '#/components/responses/Forbidden'
5232 $ref: '#/components/responses/NotFound'
5234 $ref: '#/components/responses/MethodNotAllowed'
5236 $ref: '#/components/responses/NotAcceptable'
5238 $ref: '#/components/responses/Conflict'
5240 $ref: '#/components/responses/UnprocessableEntity'
5242 $ref: '#/components/responses/InternalServerError'
5244 $ref: '#/components/responses/ServiceUnavailable'
5246 $ref: '#/components/responses/UnexpectedError'
5248 $ref: '#/components/responses/UnexpectedError'
5253 summary: Modify a VIM Account
5254 description: Modify a VIM Account
5255 operationId: editVimAccount
5257 $ref: '#/components/requestBodies/EditVimRequest'
5260 description: Accepted
5264 $ref: '#/components/schemas/OpId'
5267 $ref: '#/components/schemas/OpId'
5269 $ref: '#/components/responses/BadRequest'
5271 $ref: '#/components/responses/Unauthorized'
5273 $ref: '#/components/responses/Forbidden'
5275 $ref: '#/components/responses/NotFound'
5277 $ref: '#/components/responses/MethodNotAllowed'
5279 $ref: '#/components/responses/NotAcceptable'
5281 $ref: '#/components/responses/Conflict'
5283 $ref: '#/components/responses/UnprocessableEntity'
5285 $ref: '#/components/responses/InternalServerError'
5287 $ref: '#/components/responses/ServiceUnavailable'
5289 $ref: '#/components/responses/UnexpectedError'
5291 $ref: '#/components/responses/UnexpectedError'
5296 summary: Delete a VIM Account
5297 description: Delete a VIM Account
5298 operationId: deleteVimAccount
5301 description: Accepted
5303 $ref: '#/components/responses/BadRequest'
5305 $ref: '#/components/responses/Unauthorized'
5307 $ref: '#/components/responses/Forbidden'
5309 $ref: '#/components/responses/NotFound'
5311 $ref: '#/components/responses/MethodNotAllowed'
5313 $ref: '#/components/responses/NotAcceptable'
5315 $ref: '#/components/responses/Conflict'
5317 $ref: '#/components/responses/UnprocessableEntity'
5319 $ref: '#/components/responses/InternalServerError'
5321 $ref: '#/components/responses/ServiceUnavailable'
5323 $ref: '#/components/responses/UnexpectedError'
5325 $ref: '#/components/responses/UnexpectedError'
5326 '/admin/v1/wim_accounts':
5331 summary: Query information about multiple WIM Accounts
5332 description: Query information about multiple WIM Accounts
5333 operationId: getWimAccounts
5340 $ref: '#/components/schemas/ArrayOfWimInfo'
5343 $ref: '#/components/schemas/ArrayOfWimInfo'
5345 $ref: '#/components/responses/BadRequest'
5347 $ref: '#/components/responses/Unauthorized'
5349 $ref: '#/components/responses/Forbidden'
5351 $ref: '#/components/responses/NotFound'
5353 $ref: '#/components/responses/MethodNotAllowed'
5355 $ref: '#/components/responses/NotAcceptable'
5357 $ref: '#/components/responses/Conflict'
5359 $ref: '#/components/responses/UnprocessableEntity'
5361 $ref: '#/components/responses/InternalServerError'
5363 $ref: '#/components/responses/ServiceUnavailable'
5365 $ref: '#/components/responses/UnexpectedError'
5367 $ref: '#/components/responses/UnexpectedError'
5372 summary: Create a new WIM Account
5373 description: Create a new WIM Account
5374 operationId: createWimAccount
5376 $ref: '#/components/requestBodies/CreateWimRequest'
5379 description: Accepted
5383 $ref: '#/components/schemas/ObjectId_plus_OpId'
5386 $ref: '#/components/schemas/ObjectId_plus_OpId'
5388 $ref: '#/components/responses/BadRequest'
5390 $ref: '#/components/responses/Unauthorized'
5392 $ref: '#/components/responses/Forbidden'
5394 $ref: '#/components/responses/NotFound'
5396 $ref: '#/components/responses/MethodNotAllowed'
5398 $ref: '#/components/responses/NotAcceptable'
5400 $ref: '#/components/responses/Conflict'
5402 $ref: '#/components/responses/UnprocessableEntity'
5404 $ref: '#/components/responses/InternalServerError'
5406 $ref: '#/components/responses/ServiceUnavailable'
5408 $ref: '#/components/responses/UnexpectedError'
5410 $ref: '#/components/responses/UnexpectedError'
5411 '/admin/v1/wim_accounts/{wimAccountId}':
5413 - name: wimAccountId
5416 description: WIM Account ID
5424 summary: Query information about an individual WIM Account
5425 description: Query information about an individual WIM Account
5426 operationId: getWimAccount
5433 $ref: '#/components/schemas/WimInfo'
5436 $ref: '#/components/schemas/WimInfo'
5438 $ref: '#/components/responses/BadRequest'
5440 $ref: '#/components/responses/Unauthorized'
5442 $ref: '#/components/responses/Forbidden'
5444 $ref: '#/components/responses/NotFound'
5446 $ref: '#/components/responses/MethodNotAllowed'
5448 $ref: '#/components/responses/NotAcceptable'
5450 $ref: '#/components/responses/Conflict'
5452 $ref: '#/components/responses/UnprocessableEntity'
5454 $ref: '#/components/responses/InternalServerError'
5456 $ref: '#/components/responses/ServiceUnavailable'
5458 $ref: '#/components/responses/UnexpectedError'
5460 $ref: '#/components/responses/UnexpectedError'
5465 summary: Modify a WIM Account
5466 description: Modify a WIM Account
5467 operationId: editWimAccount
5469 $ref: '#/components/requestBodies/EditWimRequest'
5472 description: Accepted
5476 $ref: '#/components/schemas/OpId'
5479 $ref: '#/components/schemas/OpId'
5481 $ref: '#/components/responses/BadRequest'
5483 $ref: '#/components/responses/Unauthorized'
5485 $ref: '#/components/responses/Forbidden'
5487 $ref: '#/components/responses/NotFound'
5489 $ref: '#/components/responses/MethodNotAllowed'
5491 $ref: '#/components/responses/NotAcceptable'
5493 $ref: '#/components/responses/Conflict'
5495 $ref: '#/components/responses/UnprocessableEntity'
5497 $ref: '#/components/responses/InternalServerError'
5499 $ref: '#/components/responses/ServiceUnavailable'
5501 $ref: '#/components/responses/UnexpectedError'
5503 $ref: '#/components/responses/UnexpectedError'
5508 summary: Delete a WIM Account
5509 description: Delete a WIM Account
5510 operationId: deleteWimAccount
5513 description: Accepted
5515 $ref: '#/components/responses/BadRequest'
5517 $ref: '#/components/responses/Unauthorized'
5519 $ref: '#/components/responses/Forbidden'
5521 $ref: '#/components/responses/NotFound'
5523 $ref: '#/components/responses/MethodNotAllowed'
5525 $ref: '#/components/responses/NotAcceptable'
5527 $ref: '#/components/responses/Conflict'
5529 $ref: '#/components/responses/UnprocessableEntity'
5531 $ref: '#/components/responses/InternalServerError'
5533 $ref: '#/components/responses/ServiceUnavailable'
5535 $ref: '#/components/responses/UnexpectedError'
5537 $ref: '#/components/responses/UnexpectedError'
5543 summary: Query information about multiple SDNs
5544 description: Query information about multiple SDNs
5545 operationId: getSDNs
5552 $ref: '#/components/schemas/ArrayOfSdnInfo'
5555 $ref: '#/components/schemas/ArrayOfSdnInfo'
5557 $ref: '#/components/responses/BadRequest'
5559 $ref: '#/components/responses/Unauthorized'
5561 $ref: '#/components/responses/Forbidden'
5563 $ref: '#/components/responses/NotFound'
5565 $ref: '#/components/responses/MethodNotAllowed'
5567 $ref: '#/components/responses/NotAcceptable'
5569 $ref: '#/components/responses/Conflict'
5571 $ref: '#/components/responses/UnprocessableEntity'
5573 $ref: '#/components/responses/InternalServerError'
5575 $ref: '#/components/responses/ServiceUnavailable'
5577 $ref: '#/components/responses/UnexpectedError'
5579 $ref: '#/components/responses/UnexpectedError'
5584 summary: Create a new SDN
5585 description: Create a new SDN
5586 operationId: createSDN
5588 $ref: '#/components/requestBodies/CreateSdnRequest'
5591 description: Accepted
5595 $ref: '#/components/schemas/ObjectId_plus_OpId'
5598 $ref: '#/components/schemas/ObjectId_plus_OpId'
5600 $ref: '#/components/responses/BadRequest'
5602 $ref: '#/components/responses/Unauthorized'
5604 $ref: '#/components/responses/Forbidden'
5606 $ref: '#/components/responses/NotFound'
5608 $ref: '#/components/responses/MethodNotAllowed'
5610 $ref: '#/components/responses/NotAcceptable'
5612 $ref: '#/components/responses/Conflict'
5614 $ref: '#/components/responses/UnprocessableEntity'
5616 $ref: '#/components/responses/InternalServerError'
5618 $ref: '#/components/responses/ServiceUnavailable'
5620 $ref: '#/components/responses/UnexpectedError'
5622 $ref: '#/components/responses/UnexpectedError'
5623 '/admin/v1/sdns/{sdnId}':
5636 summary: Query information about an individual SDN
5637 description: Query information about an individual SDN
5645 $ref: '#/components/schemas/SdnInfo'
5648 $ref: '#/components/schemas/SdnInfo'
5650 $ref: '#/components/responses/BadRequest'
5652 $ref: '#/components/responses/Unauthorized'
5654 $ref: '#/components/responses/Forbidden'
5656 $ref: '#/components/responses/NotFound'
5658 $ref: '#/components/responses/MethodNotAllowed'
5660 $ref: '#/components/responses/NotAcceptable'
5662 $ref: '#/components/responses/Conflict'
5664 $ref: '#/components/responses/UnprocessableEntity'
5666 $ref: '#/components/responses/InternalServerError'
5668 $ref: '#/components/responses/ServiceUnavailable'
5670 $ref: '#/components/responses/UnexpectedError'
5672 $ref: '#/components/responses/UnexpectedError'
5677 summary: Modify a SDN
5678 description: Modify a SDN
5679 operationId: editSDN
5681 $ref: '#/components/requestBodies/EditSdnRequest'
5684 description: Accepted
5688 $ref: '#/components/schemas/OpId'
5691 $ref: '#/components/schemas/OpId'
5693 $ref: '#/components/responses/BadRequest'
5695 $ref: '#/components/responses/Unauthorized'
5697 $ref: '#/components/responses/Forbidden'
5699 $ref: '#/components/responses/NotFound'
5701 $ref: '#/components/responses/MethodNotAllowed'
5703 $ref: '#/components/responses/NotAcceptable'
5705 $ref: '#/components/responses/Conflict'
5707 $ref: '#/components/responses/UnprocessableEntity'
5709 $ref: '#/components/responses/InternalServerError'
5711 $ref: '#/components/responses/ServiceUnavailable'
5713 $ref: '#/components/responses/UnexpectedError'
5715 $ref: '#/components/responses/UnexpectedError'
5720 summary: Delete a SDN
5721 description: Delete a SDN
5722 operationId: deleteSDN
5725 description: Accepted
5727 $ref: '#/components/responses/BadRequest'
5729 $ref: '#/components/responses/Unauthorized'
5731 $ref: '#/components/responses/Forbidden'
5733 $ref: '#/components/responses/NotFound'
5735 $ref: '#/components/responses/MethodNotAllowed'
5737 $ref: '#/components/responses/NotAcceptable'
5739 $ref: '#/components/responses/Conflict'
5741 $ref: '#/components/responses/UnprocessableEntity'
5743 $ref: '#/components/responses/InternalServerError'
5745 $ref: '#/components/responses/ServiceUnavailable'
5747 $ref: '#/components/responses/UnexpectedError'
5749 $ref: '#/components/responses/UnexpectedError'
5750 '/admin/v1/k8sclusters':
5755 summary: Query information about multiple K8s Clusters
5756 description: Query information about multiple K8s Clusters
5757 operationId: getK8sClusters
5764 $ref: '#/components/schemas/ArrayOfK8sClusterInfo'
5767 $ref: '#/components/schemas/ArrayOfK8sClusterInfo'
5769 $ref: '#/components/responses/BadRequest'
5771 $ref: '#/components/responses/Unauthorized'
5773 $ref: '#/components/responses/Forbidden'
5775 $ref: '#/components/responses/NotFound'
5777 $ref: '#/components/responses/MethodNotAllowed'
5779 $ref: '#/components/responses/NotAcceptable'
5781 $ref: '#/components/responses/Conflict'
5783 $ref: '#/components/responses/UnprocessableEntity'
5785 $ref: '#/components/responses/InternalServerError'
5787 $ref: '#/components/responses/ServiceUnavailable'
5789 $ref: '#/components/responses/UnexpectedError'
5791 $ref: '#/components/responses/UnexpectedError'
5796 summary: Create a new K8s Cluster
5797 description: Create a new K8s Cluster
5798 operationId: createK8sCluster
5800 $ref: '#/components/requestBodies/CreateK8sClusterRequest'
5803 description: Accepted
5807 $ref: '#/components/schemas/ObjectId_plus_OpId'
5810 $ref: '#/components/schemas/ObjectId_plus_OpId'
5812 $ref: '#/components/responses/BadRequest'
5814 $ref: '#/components/responses/Unauthorized'
5816 $ref: '#/components/responses/Forbidden'
5818 $ref: '#/components/responses/NotFound'
5820 $ref: '#/components/responses/MethodNotAllowed'
5822 $ref: '#/components/responses/NotAcceptable'
5824 $ref: '#/components/responses/Conflict'
5826 $ref: '#/components/responses/UnprocessableEntity'
5828 $ref: '#/components/responses/InternalServerError'
5830 $ref: '#/components/responses/ServiceUnavailable'
5832 $ref: '#/components/responses/UnexpectedError'
5834 $ref: '#/components/responses/UnexpectedError'
5835 '/admin/v1/k8sclusters/{k8sClusterId}':
5837 - name: k8sClusterId
5840 description: K8s Cluster ID
5848 summary: Query information about an individual K8s Cluster
5849 description: Query information about an individual K8s Cluster
5850 operationId: getK8sCluster
5857 $ref: '#/components/schemas/K8sClusterInfo'
5860 $ref: '#/components/schemas/K8sClusterInfo'
5862 $ref: '#/components/responses/BadRequest'
5864 $ref: '#/components/responses/Unauthorized'
5866 $ref: '#/components/responses/Forbidden'
5868 $ref: '#/components/responses/NotFound'
5870 $ref: '#/components/responses/MethodNotAllowed'
5872 $ref: '#/components/responses/NotAcceptable'
5874 $ref: '#/components/responses/Conflict'
5876 $ref: '#/components/responses/UnprocessableEntity'
5878 $ref: '#/components/responses/InternalServerError'
5880 $ref: '#/components/responses/ServiceUnavailable'
5882 $ref: '#/components/responses/UnexpectedError'
5884 $ref: '#/components/responses/UnexpectedError'
5889 summary: Modify a K8s Cluster
5890 description: Modify a K8s Cluster
5891 operationId: editK8sCluster
5893 $ref: '#/components/requestBodies/EditK8sClusterRequest'
5896 description: Accepted
5900 $ref: '#/components/schemas/OpId'
5903 $ref: '#/components/schemas/OpId'
5905 $ref: '#/components/responses/BadRequest'
5907 $ref: '#/components/responses/Unauthorized'
5909 $ref: '#/components/responses/Forbidden'
5911 $ref: '#/components/responses/NotFound'
5913 $ref: '#/components/responses/MethodNotAllowed'
5915 $ref: '#/components/responses/NotAcceptable'
5917 $ref: '#/components/responses/Conflict'
5919 $ref: '#/components/responses/UnprocessableEntity'
5921 $ref: '#/components/responses/InternalServerError'
5923 $ref: '#/components/responses/ServiceUnavailable'
5925 $ref: '#/components/responses/UnexpectedError'
5927 $ref: '#/components/responses/UnexpectedError'
5932 summary: Delete a K8s Cluster
5933 description: Delete a K8s Cluster
5934 operationId: deleteK8sCluster
5937 description: Accepted
5939 $ref: '#/components/responses/BadRequest'
5941 $ref: '#/components/responses/Unauthorized'
5943 $ref: '#/components/responses/Forbidden'
5945 $ref: '#/components/responses/NotFound'
5947 $ref: '#/components/responses/MethodNotAllowed'
5949 $ref: '#/components/responses/NotAcceptable'
5951 $ref: '#/components/responses/Conflict'
5953 $ref: '#/components/responses/UnprocessableEntity'
5955 $ref: '#/components/responses/InternalServerError'
5957 $ref: '#/components/responses/ServiceUnavailable'
5959 $ref: '#/components/responses/UnexpectedError'
5961 $ref: '#/components/responses/UnexpectedError'
5967 summary: Query information about multiple VCAs
5968 description: Query information about multiple VCAs
5969 operationId: getVcas
5976 $ref: '#/components/schemas/ArrayOfVcaInfo'
5979 $ref: '#/components/schemas/ArrayOfVcaInfo'
5981 $ref: '#/components/responses/BadRequest'
5983 $ref: '#/components/responses/Unauthorized'
5985 $ref: '#/components/responses/Forbidden'
5987 $ref: '#/components/responses/NotFound'
5989 $ref: '#/components/responses/MethodNotAllowed'
5991 $ref: '#/components/responses/NotAcceptable'
5993 $ref: '#/components/responses/Conflict'
5995 $ref: '#/components/responses/UnprocessableEntity'
5997 $ref: '#/components/responses/InternalServerError'
5999 $ref: '#/components/responses/ServiceUnavailable'
6001 $ref: '#/components/responses/UnexpectedError'
6003 $ref: '#/components/responses/UnexpectedError'
6008 summary: Create a new VCA
6009 description: Create a new VCA
6010 operationId: createVca
6012 $ref: '#/components/requestBodies/CreateVcaRequest'
6015 description: Accepted
6019 $ref: '#/components/schemas/ObjectId_plus_OpId'
6022 $ref: '#/components/schemas/ObjectId_plus_OpId'
6024 $ref: '#/components/responses/BadRequest'
6026 $ref: '#/components/responses/Unauthorized'
6028 $ref: '#/components/responses/Forbidden'
6030 $ref: '#/components/responses/NotFound'
6032 $ref: '#/components/responses/MethodNotAllowed'
6034 $ref: '#/components/responses/NotAcceptable'
6036 $ref: '#/components/responses/Conflict'
6038 $ref: '#/components/responses/UnprocessableEntity'
6040 $ref: '#/components/responses/InternalServerError'
6042 $ref: '#/components/responses/ServiceUnavailable'
6044 $ref: '#/components/responses/UnexpectedError'
6046 $ref: '#/components/responses/UnexpectedError'
6047 '/admin/v1/vca/{vcaId}':
6060 summary: Query information about an individual VCA
6061 description: Query information about an individual VCA
6069 $ref: '#/components/schemas/VcaInfo'
6072 $ref: '#/components/schemas/VcaInfo'
6074 $ref: '#/components/responses/BadRequest'
6076 $ref: '#/components/responses/Unauthorized'
6078 $ref: '#/components/responses/Forbidden'
6080 $ref: '#/components/responses/NotFound'
6082 $ref: '#/components/responses/MethodNotAllowed'
6084 $ref: '#/components/responses/NotAcceptable'
6086 $ref: '#/components/responses/Conflict'
6088 $ref: '#/components/responses/UnprocessableEntity'
6090 $ref: '#/components/responses/InternalServerError'
6092 $ref: '#/components/responses/ServiceUnavailable'
6094 $ref: '#/components/responses/UnexpectedError'
6096 $ref: '#/components/responses/UnexpectedError'
6101 summary: Modify a VCA
6102 description: Modify a VCA
6103 operationId: editVca
6105 $ref: '#/components/requestBodies/EditVcaRequest'
6108 description: Accepted
6112 $ref: '#/components/schemas/OpId'
6115 $ref: '#/components/schemas/OpId'
6117 $ref: '#/components/responses/BadRequest'
6119 $ref: '#/components/responses/Unauthorized'
6121 $ref: '#/components/responses/Forbidden'
6123 $ref: '#/components/responses/NotFound'
6125 $ref: '#/components/responses/MethodNotAllowed'
6127 $ref: '#/components/responses/NotAcceptable'
6129 $ref: '#/components/responses/Conflict'
6131 $ref: '#/components/responses/UnprocessableEntity'
6133 $ref: '#/components/responses/InternalServerError'
6135 $ref: '#/components/responses/ServiceUnavailable'
6137 $ref: '#/components/responses/UnexpectedError'
6139 $ref: '#/components/responses/UnexpectedError'
6144 summary: Delete a VCA
6145 description: Delete a VCA
6146 operationId: deleteVca
6149 description: Accepted
6151 $ref: '#/components/responses/BadRequest'
6153 $ref: '#/components/responses/Unauthorized'
6155 $ref: '#/components/responses/Forbidden'
6157 $ref: '#/components/responses/NotFound'
6159 $ref: '#/components/responses/MethodNotAllowed'
6161 $ref: '#/components/responses/NotAcceptable'
6163 $ref: '#/components/responses/Conflict'
6165 $ref: '#/components/responses/UnprocessableEntity'
6167 $ref: '#/components/responses/InternalServerError'
6169 $ref: '#/components/responses/ServiceUnavailable'
6171 $ref: '#/components/responses/UnexpectedError'
6173 $ref: '#/components/responses/UnexpectedError'
6174 '/admin/v1/k8srepos':
6179 summary: Query information about multiple K8s Repos
6180 description: Query information about multiple K8s Repos
6181 operationId: getK8sRepos
6188 $ref: '#/components/schemas/ArrayOfK8sRepoInfo'
6191 $ref: '#/components/schemas/ArrayOfK8sRepoInfo'
6193 $ref: '#/components/responses/BadRequest'
6195 $ref: '#/components/responses/Unauthorized'
6197 $ref: '#/components/responses/Forbidden'
6199 $ref: '#/components/responses/NotFound'
6201 $ref: '#/components/responses/MethodNotAllowed'
6203 $ref: '#/components/responses/NotAcceptable'
6205 $ref: '#/components/responses/Conflict'
6207 $ref: '#/components/responses/UnprocessableEntity'
6209 $ref: '#/components/responses/InternalServerError'
6211 $ref: '#/components/responses/ServiceUnavailable'
6213 $ref: '#/components/responses/UnexpectedError'
6215 $ref: '#/components/responses/UnexpectedError'
6220 summary: Create a new K8s Repo
6221 description: Create a new K8s Repo
6222 operationId: createK8sRepo
6224 $ref: '#/components/requestBodies/CreateK8sRepoRequest'
6227 description: Accepted
6231 $ref: '#/components/schemas/ObjectId_plus_OpId'
6234 $ref: '#/components/schemas/ObjectId_plus_OpId'
6236 $ref: '#/components/responses/BadRequest'
6238 $ref: '#/components/responses/Unauthorized'
6240 $ref: '#/components/responses/Forbidden'
6242 $ref: '#/components/responses/NotFound'
6244 $ref: '#/components/responses/MethodNotAllowed'
6246 $ref: '#/components/responses/NotAcceptable'
6248 $ref: '#/components/responses/Conflict'
6250 $ref: '#/components/responses/UnprocessableEntity'
6252 $ref: '#/components/responses/InternalServerError'
6254 $ref: '#/components/responses/ServiceUnavailable'
6256 $ref: '#/components/responses/UnexpectedError'
6258 $ref: '#/components/responses/UnexpectedError'
6259 '/admin/v1/k8srepos/{k8sRepoId}':
6264 description: K8s Repo ID
6272 summary: Query information about an individual K8s Repo
6273 description: Query information about an individual K8s Repo
6274 operationId: getK8sRepo
6281 $ref: '#/components/schemas/K8sRepoInfo'
6284 $ref: '#/components/schemas/K8sRepoInfo'
6286 $ref: '#/components/responses/BadRequest'
6288 $ref: '#/components/responses/Unauthorized'
6290 $ref: '#/components/responses/Forbidden'
6292 $ref: '#/components/responses/NotFound'
6294 $ref: '#/components/responses/MethodNotAllowed'
6296 $ref: '#/components/responses/NotAcceptable'
6298 $ref: '#/components/responses/Conflict'
6300 $ref: '#/components/responses/UnprocessableEntity'
6302 $ref: '#/components/responses/InternalServerError'
6304 $ref: '#/components/responses/ServiceUnavailable'
6306 $ref: '#/components/responses/UnexpectedError'
6308 $ref: '#/components/responses/UnexpectedError'
6313 summary: Delete a K8s Repo
6314 description: Delete a K8s Repo
6315 operationId: deleteK8sRepo
6318 description: Accepted
6320 $ref: '#/components/responses/BadRequest'
6322 $ref: '#/components/responses/Unauthorized'
6324 $ref: '#/components/responses/Forbidden'
6326 $ref: '#/components/responses/NotFound'
6328 $ref: '#/components/responses/MethodNotAllowed'
6330 $ref: '#/components/responses/NotAcceptable'
6332 $ref: '#/components/responses/Conflict'
6334 $ref: '#/components/responses/UnprocessableEntity'
6336 $ref: '#/components/responses/InternalServerError'
6338 $ref: '#/components/responses/ServiceUnavailable'
6340 $ref: '#/components/responses/UnexpectedError'
6342 $ref: '#/components/responses/UnexpectedError'
6346 description: Find out more about OSM
6347 url: 'https://osm.etsi.org/docs/user-guide/'
6352 description: Bad request. The server cannot process the request due to a client error.
6356 $ref: '#/components/schemas/ProblemDetails'
6358 description: Authorization information is missing or invalid.
6362 $ref: '#/components/schemas/ProblemDetails'
6364 description: Not enough permissions to do this operation.
6368 $ref: '#/components/schemas/ProblemDetails'
6370 description: The specified resource was not found.
6374 $ref: '#/components/schemas/ProblemDetails'
6376 description: This method is not supported for the requested resource.
6380 $ref: '#/components/schemas/ProblemDetails'
6382 description: The requested resource content cannot match the Accept headers sent in the request.
6386 $ref: '#/components/schemas/ProblemDetails'
6388 description: The operation cannot be executed currently, due to a conflict with the state of the resource.
6392 $ref: '#/components/schemas/ProblemDetails'
6393 UnprocessableEntity:
6394 description: The request was well-formed but was unable to be followed due to semantic errors.
6398 $ref: '#/components/schemas/ProblemDetails'
6399 InternalServerError:
6400 description: Internal server error.
6404 $ref: '#/components/schemas/ProblemDetails'
6406 description: Service temporarily unavailable.
6410 $ref: '#/components/schemas/ProblemDetails'
6412 description: Unexpected error.
6416 $ref: '#/components/schemas/ProblemDetails'
6418 description: VNF Descriptor (plaintext)
6422 $ref: '#/components/schemas/VnfDescriptor'
6424 description: VNF Package (compressed)
6428 $ref: '#/components/schemas/VnfPackage'
6430 description: NS Descriptor (plaintext)
6434 $ref: '#/components/schemas/NsDescriptor'
6436 description: NS Package (compressed)
6440 $ref: '#/components/schemas/NsPackage'
6442 description: NetSlice Template (plaintext)
6446 $ref: '#/components/schemas/NetSliceTemplate'
6448 description: NetSlice Package (compressed)
6452 $ref: '#/components/schemas/NetSlicePackage'
6453 NslcmSubscriptionResponse:
6454 description: NslcmSubscriptionResponse
6458 $ref: '#/components/schemas/NslcmSubscriptionResponse'
6461 $ref: '#/components/schemas/NslcmSubscriptionResponse'
6472 # A free list of key:value pairs
6474 additionalProperties: true
6481 CreateNsdInfoRequest:
6482 # A free list of key:value pairs
6484 additionalProperties: true
6485 NsdInfoModifications:
6487 NS Descriptor Information
6488 Only generic fields (id, name, description) are described
6489 For a full specification of the NS Descriptor see:
6490 http://osm-download.etsi.org/ftp/osm-doc/nsd.html
6494 description: NSD Identifier
6497 description: NSD Name
6500 description: NSD Description
6502 AlarmInfoModifications:
6511 description: To enable/disable the alarm.
6514 description: Threshold value of the Alarm
6518 NS Descriptor Information
6519 Only generic fields (_id, id, name, description) are described
6520 For a full specification of the NS Descriptor see:
6521 http://osm-download.etsi.org/ftp/osm-doc/nsd.html
6526 Identifier of the onboarded individual NS descriptor
6527 resource. This identifier is allocated by the NFVO.
6532 This identifier, which is allocated by the NSD
6533 designer, identifies the NSD in a globally unique
6534 way. It is copied from the NSD content and shall be
6535 present after the NSD content is on-boarded.
6539 Name of the onboarded NSD. This information is
6540 copied from the NSD content and shall be present
6541 after the NSD content is on-boarded.
6545 Description of the onboarded NSD.
6546 This information is copied from the NSD content.
6554 $ref: '#/components/schemas/NsdInfo'
6570 additionalProperties: true
6580 CreateVnfPkgInfoRequest:
6581 # A free list of key:value pairs
6583 additionalProperties: true
6584 VnfPkgInfoModifications:
6586 VNF Package Information
6587 Only generic fields (id, name, description) are described
6588 For a full specification of the VNF Descriptor see:
6589 http://osm-download.etsi.org/ftp/osm-doc/vnfd.html
6593 description: VNF Package Identifier
6596 description: VNF Package Name
6599 description: VNF Package description
6603 VNF Package Information
6604 Only generic fields (_id, id, name, description) are described
6605 For a full specification of the VNF Descriptor see:
6606 http://osm-download.etsi.org/ftp/osm-doc/vnfd.html
6611 Identifier of the VNF package. This identifier is allocated by the NFVO.
6615 description: VNF Package Identifier
6618 description: VNF Package Name
6621 description: VNF Package description
6629 $ref: '#/components/schemas/VnfPkgInfo'
6631 # Substituted by InstantiateNsRequest
6634 NS Instance Information
6635 Only generic fields (_id, id, name, description) are described
6636 For a full specification of the NS Instance see:
6637 http://osm-download.etsi.org/ftp/osm-doc/nsr.html
6641 description: Identifier of the NS instance.
6645 description: Identifier of the NS instance.
6649 description: Human readable name of the NS instance.
6652 description: Human readable description of the NS instance.
6658 InstantiateNsRequest:
6663 Human-readable name of the NS instance to be created.
6667 Identifier of the NSD that defines the NS instance to be created.
6672 Identifier of the VIM Account where the NS instance shall be created.
6691 additionalParamsForNs:
6693 additionalProperties: true
6694 additionalParamsForVnf: &additionalparamsforvnf
6703 additionalProperties: true
6707 use this namespace for all the KDU deployed in this VNF
6708 (if any). By default it is used the id of the project
6709 additionalParamsForVdu:
6718 additionalProperties: true
6722 additionalProperties: false
6723 additionalParamsForKdu:
6732 description: use this namespace for this KDU
6737 additionalProperties: true
6741 additionalProperties: false
6745 additionalProperties: false
6758 To compute automatically the target VIM for each VNF based on
6759 constrains, e.g. latency. Currently only 'PLA' is supported
6760 placement-constraints:
6762 additionalProperties: true
6796 additionalProperties: false
6811 floating-ip-required:
6815 additionalProperties: false
6819 additionalProperties: false
6858 additionalProperties: false
6872 additionalProperties: false
6874 additionalProperties: false
6886 connect additional ports to the created underlay SDN connectivity.
6887 Normally for external connectivy.
6901 additionalProperties: true
6906 additionalProperties: false
6907 internal-connection-point:
6920 additionalProperties: False
6925 additionalProperties: false
6930 additionalProperties: false
6949 additionalProperties: true
6957 additionalProperties: true
6965 additionalProperties: false
6966 vnfd-connection-point-ref:
6971 member-vnf-index-ref:
6973 vnfd-connection-point-ref:
6979 - member-vnf-index-ref
6980 - vnfd-connection-point-ref
6982 additionalProperties: false
6986 additionalProperties: false
6992 additionalProperties: false
7001 description: timeout for the scale operation
7014 scaling-group-descriptor:
7021 - scaling-group-descriptor
7023 additionalProperties: false
7027 additionalProperties: false
7031 additionalProperties: false
7034 This type represents request parameters for the "Heal NS" operation. This operation supports the healing of an NS
7035 instance by healing one or more of the VNF that are part of this NS.
7039 description: timeout for the heal operation in seconds
7043 List of VNF to be healed, together with the information needed to heal each.
7046 $ref: "#/components/schemas/HealVnfData"
7051 This type represents the information to heal a VNF that is part of an NS.
7058 Identifies the VNF instance, part of the NS, requiring a
7064 Indicates the reason why a healing procedure is required.
7068 Additional parameters passed by the NFVO as input to
7069 the healing process, specific to the VNF being healed.
7074 Flag to indicate whether or not to run day1 primitives for the VNF (default: false).
7079 List of VDU to be healed, together with the information needed to heal each.
7082 $ref: "#/components/schemas/HealVduData"
7085 This type represents the information to heal a VDU that is part of a VNF.
7092 Identifies the VDU id, part of the VNF, requiring a healing action.
7097 Indicates the VDU number when the VDU is part of a scale-group.
7102 Flag to indicate whether or not to run day1 primitives for the VDU (default: false).
7105 NSinstanceMigrateRequest:
7107 This type represents request parameters for the "Migrate" operation. This operation supports the migration of an NS
7108 instance by migrating one or more of the VDUs that are part of this NS.
7126 additionalProperties: false
7130 timeout_ns_terminate:
7131 description: timeout for terminate operation
7134 description: remove network service if termination end without error
7136 skip_terminate_primitives:
7137 description: Do not execute network service termination primitives
7139 additionalProperties: false
7143 $ref: '#/components/schemas/NsInstance'
7144 NSinstanceActionRequest:
7150 name of the primitive in the 'config-descriptor'. If the target is
7151 a kdu it can be also 'status', 'rollback' or 'upgrade'
7153 description: parameters of this primitive
7154 $ref: '#/components/schemas/KeyValuePairs'
7157 description: provide if the target action is for a vnf, vdu or kdu
7160 description: provide if the target action is for a vdu
7163 description: provide if the target action is for a kdu
7167 description: timeout for the day 1/2 operation
7172 additionalProperties: false
7175 This type represents request parameters for the "Update NS" operation. This operation supports the update of an NS
7176 instance by updating one or more of the VNFs that are part of this NS.
7184 - MODIFY_VNF_INFORMATION
7186 changeVnfPackageData:
7196 removeVnfInstanceId:
7230 additionalProperties: false
7233 additionalProperties: false
7234 # CreateNSinstanceContentRequest:
7235 # Substituted by InstantiateNsRequest
7236 CreateNSinstanceContentResponse:
7259 isAutomaticInvocation:
7301 $ref: '#/components/schemas/NsLcmOpOcc'
7304 VNF Instance Information
7305 Only generic fields (_id, id) are described
7306 For a full specification of the VNF Instance see:
7307 http://osm-download.etsi.org/ftp/osm-doc/vnfr.html
7316 ArrayOfVnfInstanceInfo:
7319 $ref: '#/components/schemas/VnfInstanceInfo'
7322 NetSlice Template Information
7323 Only generic fields (_id, id, name) are described
7324 For a full specification of the NetSlice Template see:
7325 http://osm-download.etsi.org/ftp/osm-doc/nst.html
7329 description: NetSlice Template Identifier
7333 description: Human readable NetSlice Template Identifier
7336 description: Human readable name of the NetSlice Template
7341 $ref: '#/components/schemas/NstInfo'
7342 CreateNstInfoRequest:
7343 # A free list of key:value pairs
7345 additionalProperties: true
7352 NstInfoModifications:
7354 NetSlice Template Information
7355 Only generic fields (id, name) are described
7356 For a full specification of the NetSlice Template see:
7357 http://osm-download.etsi.org/ftp/osm-doc/nst.html
7361 description: NST Identifier
7364 description: NST Name
7368 NetSlice Instance Information
7369 Only generic fields (_id, id, name, description) are described
7370 For a full specification of the NetSlice Instance see:
7371 http://osm-download.etsi.org/ftp/osm-doc/nsi.html
7375 description: Identifier of the NetSlice instance.
7379 description: Identifier of the NetSlice instance.
7383 description: Human readable name of the NetSlice instance.
7386 description: Human readable description of the NetSlice instance.
7392 ArrayOfNetSliceInstance:
7395 $ref: '#/components/schemas/NetSliceInstance'
7402 description: Identifier of the Alarm.
7406 description: Identifier of the Alarm.
7410 description: Alarm metric.
7413 description: Threshold value of the Alarm.
7417 description: Operation to be applied.
7420 description: Action to be taken.
7423 description: Current status of the alarm.
7434 $ref: '#/components/schemas/Alarm'
7436 # Substituted by InstantiateNsiRequest
7437 InstantiateNsiRequest:
7442 Human-readable name of the NetSlice instance to be created.
7446 Identifier of the NST that defines the NetSlice instance to be created.
7451 Identifier of the VIM Account where the NetSlice instance shall be created.
7467 additionalParamsForNsi:
7469 additionalProperties: true
7501 additionalParamsForNs:
7503 additionalProperties: true
7504 additionalParamsForVnf: *additionalparamsforvnf
7543 additionalProperties: false
7558 floating-ip-required:
7562 additionalProperties: false
7566 additionalProperties: false
7605 additionalProperties: false
7619 additionalProperties: false
7621 additionalProperties: false
7629 additionalProperties: false
7630 internal-connection-point:
7643 additionalProperties: False
7648 additionalProperties: false
7653 additionalProperties: false
7672 additionalProperties: true
7680 additionalProperties: true
7688 additionalProperties: false
7689 vnfd-connection-point-ref:
7694 member-vnf-index-ref:
7696 vnfd-connection-point-ref:
7702 - member-vnf-index-ref
7703 - vnfd-connection-point-ref
7705 additionalProperties: false
7709 additionalProperties: false
7711 additionalProperties: false
7730 additionalProperties: true
7733 additionalProperties: false
7739 additionalProperties: false
7740 TerminateNsiRequest:
7745 Timestamp indicating the end time of the NSI, i.e. the NSI will be terminated
7746 automatically at this timestamp. Cardinality "0" indicates the NSI termination
7747 takes place immediately.
7756 $ref: '#/components/schemas/KeyValuePairs'
7765 # CreateNsiContentRequest:
7766 # Substituted by InstantiateNsiRequest
7767 CreateNsiContentResponse:
7790 isAutomaticInvocation:
7837 $ref: '#/components/schemas/NsiLcmOpOcc'
7891 $ref: '#/components/schemas/TokenInfo'
7914 project_role_mappings:
7936 $ref: '#/components/schemas/UserInfo'
7937 ProjectRoleMappings:
7949 additionalProperties: false
7950 ProjectRoleMappingsOpt:
7961 additionalProperties: false
7973 project_role_mappings:
7974 $ref: '#/components/schemas/ProjectRoleMappings'
7978 additionalProperties: false
7985 additionalProperties: true
7988 Array edition keys must start with '$'
7989 and follow the syntax defined in: https://osm.etsi.org/wikipub/index.php/NBI_API_Description
7999 - $ref: '#/components/schemas/ShortNameList'
8000 - $ref: '#/components/schemas/ArrayEditionSchema'
8001 project_role_mappings:
8002 $ref: '#/components/schemas/ProjectRoleMappings'
8003 add_project_role_mappings:
8004 $ref: '#/components/schemas/ProjectRoleMappings'
8005 remove_project_role_mappings:
8006 $ref: '#/components/schemas/ProjectRoleMappingsOpt'
8062 additionalProperties: false
8118 additionalProperties: false
8128 $ref: '#/components/schemas/QuotasInfo'
8132 $ref: '#/components/schemas/ProjectInfo'
8133 CreateProjectRequest:
8141 $ref: '#/components/schemas/QuotasInfo'
8144 additionalProperties: false
8153 $ref: '#/components/schemas/EditQuotasInfo'
8154 additionalProperties: false
8157 additionalProperties:
8161 Permissions keys must follow the syntax 'main_topic[:subtopic[:id[:component|action|etc]]]'
8162 Permission values are either true or false
8163 EditPermissionsInfo:
8165 additionalProperties:
8169 Permissions keys must follow the syntax 'main_topic[:subtopic[:id[:component|action|etc]]]'
8170 Permission values are either true, false, or null
8180 $ref: '#/components/schemas/PermissionsInfo'
8184 $ref: '#/components/schemas/RoleInfo'
8191 $ref: '#/components/schemas/PermissionsInfo'
8194 additionalProperties: false
8201 $ref: '#/components/schemas/EditPermissionsInfo'
8202 additionalProperties: false
8233 $ref: '#/components/schemas/VimType'
8248 additionalProperties: true
8254 $ref: '#/components/schemas/VimInfo'
8272 $ref: '#/components/schemas/VimType'
8287 additionalProperties: true
8297 additionalProperties: false
8310 $ref: '#/components/schemas/VimType'
8325 additionalProperties: true
8326 additionalProperties: false
8368 $ref: '#/components/schemas/WimType'
8378 additionalProperties: true
8382 $ref: '#/components/schemas/WimInfo'
8398 $ref: '#/components/schemas/WimType'
8408 additionalProperties: true
8413 additionalProperties: false
8434 additionalProperties: true
8435 additionalProperties: false
8474 - $ref: '#/components/schemas/SdnExtraProperties'
8475 - $ref: '#/components/schemas/SdnBasicProperties'
8479 $ref: '#/components/schemas/SdnInfo'
8482 - $ref: '#/components/schemas/SdnBasicProperties'
8489 additionalProperties: false
8492 - $ref: '#/components/schemas/SdnBasicProperties'
8493 additionalProperties: false
8549 additionalProperties: false
8573 $ref: '#/components/schemas/PduInterfaces'
8577 $ref: '#/components/schemas/PduInfo'
8598 $ref: '#/components/schemas/PduInterfaces'
8603 additionalProperties: false
8624 $ref: '#/components/schemas/PduInterfaces'
8625 additionalProperties: false
8630 additionalProperties: false
8631 K8sClusterDeploymentMethods:
8640 additionalProperties: false
8659 additionalProperties: true
8666 $ref: '#/components/schemas/K8sClusterNetList'
8668 $ref: '#/components/schemas/K8sClusterDeploymentMethods'
8675 ArrayOfK8sClusterInfo:
8678 $ref: '#/components/schemas/K8sClusterInfo'
8679 CreateK8sClusterRequest:
8693 additionalProperties: true
8700 $ref: '#/components/schemas/K8sClusterNetList'
8713 additionalProperties: false
8714 EditK8sClusterRequest:
8723 additionalProperties: true
8730 $ref: '#/components/schemas/K8sClusterNetList'
8737 additionalProperties: false
8771 additionalProperties: true
8775 $ref: '#/components/schemas/VcaInfo'
8806 additionalProperties: true
8817 additionalProperties: false
8843 additionalProperties: true
8844 additionalProperties: false
8861 $ref: '#/components/schemas/K8sRepoType'
8867 description: repository username
8870 description: repository password
8873 description: verify certificates of HTTPS-enabled servers using this CA bundle
8876 description: identify HTTPS client using this SSL certificate file
8879 description: skip tls certificate checks for the repository
8882 description: identify HTTPS client using this SSL key file
8886 $ref: '#/components/schemas/K8sRepoInfo'
8887 CreateK8sRepoRequest:
8895 $ref: '#/components/schemas/K8sRepoType'
8903 additionalProperties: false
8904 NslcmSubscriptionResponse:
8917 NslcmSubscriptionInfo:
8934 $ref: '#/components/schemas/Authenticationschema'
8935 ArrayOfNslcmSubscriptionInfo:
8938 $ref: '#/components/schemas/NslcmSubscriptionInfo'
8939 NsInstanceSubscriptionFilter:
8941 used to identify the network service
8944 - $ref: '#/components/schemas/nsdIds'
8945 - $ref: '#/components/schemas/vnfdIds'
8946 - $ref: '#/components/schemas/pnfdIds'
8947 - $ref: '#/components/schemas/nsInstanceIds'
8948 - $ref: '#/components/schemas/nsInstanceNames'
8972 nsInstanceSubscriptionFilter:
8973 $ref: '#/components/schemas/NsInstanceSubscriptionFilter'
8976 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
8981 - NsIdentifierCreationNotification
8982 - NsIdentifierDeletionNotification
8983 - NsLcmOperationOccurrenceNotification
8984 - NsChangeNotification
9002 - PARTIALLY_COMPLETED
9015 lcmOpNameImpactingNsComponent:
9022 - VNF_SCALE_TO_LEVEL
9023 - VNF_CHANGE_FLAVOUR
9027 - VNF_CHANGE_EXT_CONN
9034 lcmOpOccStatusImpactingNsComponent:
9041 - PARTIALLY_COMPLETED
9044 Authenticationschema:
9058 NslcmSubscriptionRequest:
9062 $ref: '#/components/schemas/Nslcmsubschema'
9067 $ref: '#/components/schemas/Authenticationschema'
9073 CreateNsdInfoRequest:
9077 $ref: '#/components/schemas/CreateNsdInfoRequest'
9080 $ref: '#/components/schemas/CreateNsdInfoRequest'
9081 NsdInfoModifications:
9085 $ref: '#/components/schemas/NsdInfoModifications'
9088 $ref: '#/components/schemas/NsdInfoModifications'
9089 AlarmInfoModifications:
9093 $ref: '#/components/schemas/AlarmInfoModifications'
9096 $ref: '#/components/schemas/AlarmInfoModifications'
9101 $ref: '#/components/schemas/NsDescriptor'
9106 $ref: '#/components/schemas/NsPackage'
9107 CreateVnfPkgInfoRequest:
9111 $ref: '#/components/schemas/CreateVnfPkgInfoRequest'
9114 $ref: '#/components/schemas/CreateVnfPkgInfoRequest'
9115 VnfPkgInfoModifications:
9119 $ref: '#/components/schemas/VnfPkgInfoModifications'
9122 $ref: '#/components/schemas/VnfPkgInfoModifications'
9127 $ref: '#/components/schemas/VnfPackage'
9132 $ref: '#/components/schemas/VnfDescriptor'
9134 # Substituted by InstantiateNsRequest
9135 InstantiateNsRequest:
9139 $ref: '#/components/schemas/InstantiateNsRequest'
9142 $ref: '#/components/schemas/InstantiateNsRequest'
9147 $ref: '#/components/schemas/HealNsRequest'
9150 $ref: '#/components/schemas/HealNsRequest'
9151 NSinstanceMigrateRequest:
9155 $ref: '#/components/schemas/NSinstanceMigrateRequest'
9158 $ref: '#/components/schemas/NSinstanceMigrateRequest'
9163 $ref: '#/components/schemas/ScaleNsRequest'
9166 $ref: '#/components/schemas/ScaleNsRequest'
9171 $ref: '#/components/schemas/TerminateNsRequest'
9174 $ref: '#/components/schemas/TerminateNsRequest'
9179 $ref: '#/components/schemas/UpdateNsRequest'
9182 $ref: '#/components/schemas/UpdateNsRequest'
9183 # CreateNSinstanceContentRequest:
9184 # Substituted by InstantiateNsRequest
9185 CreateNstInfoRequest:
9189 $ref: '#/components/schemas/CreateNstInfoRequest'
9192 $ref: '#/components/schemas/CreateNstInfoRequest'
9197 $ref: '#/components/schemas/NetSliceTemplate'
9202 $ref: '#/components/schemas/NetSlicePackage'
9203 NstInfoModifications:
9207 $ref: '#/components/schemas/NstInfoModifications'
9210 $ref: '#/components/schemas/NstInfoModifications'
9212 # Substituted by InstantiateNsiRequest
9213 InstantiateNsiRequest:
9217 $ref: '#/components/schemas/InstantiateNsiRequest'
9220 $ref: '#/components/schemas/InstantiateNsiRequest'
9221 TerminateNsiRequest:
9225 $ref: '#/components/schemas/TerminateNsiRequest'
9228 $ref: '#/components/schemas/TerminateNsiRequest'
9233 $ref: '#/components/schemas/NsiActionRequest'
9236 $ref: '#/components/schemas/NsiActionRequest'
9237 # CreateNsiContentRequest:
9238 # Substituted by InstantiateNsiRequest
9243 $ref: '#/components/schemas/CreateTokenRequest'
9246 $ref: '#/components/schemas/CreateTokenRequest'
9251 $ref: '#/components/schemas/CreateUserRequest'
9254 $ref: '#/components/schemas/CreateUserRequest'
9259 $ref: '#/components/schemas/EditUserRequest'
9262 $ref: '#/components/schemas/EditUserRequest'
9263 CreateProjectRequest:
9267 $ref: '#/components/schemas/CreateProjectRequest'
9270 $ref: '#/components/schemas/CreateProjectRequest'
9275 $ref: '#/components/schemas/EditProjectRequest'
9278 $ref: '#/components/schemas/EditProjectRequest'
9283 $ref: '#/components/schemas/CreateRoleRequest'
9286 $ref: '#/components/schemas/CreateRoleRequest'
9291 $ref: '#/components/schemas/EditRoleRequest'
9294 $ref: '#/components/schemas/EditRoleRequest'
9299 $ref: '#/components/schemas/CreateVimRequest'
9302 $ref: '#/components/schemas/CreateVimRequest'
9307 $ref: '#/components/schemas/EditVimRequest'
9310 $ref: '#/components/schemas/EditVimRequest'
9315 $ref: '#/components/schemas/CreateWimRequest'
9318 $ref: '#/components/schemas/CreateWimRequest'
9323 $ref: '#/components/schemas/EditWimRequest'
9326 $ref: '#/components/schemas/EditWimRequest'
9331 $ref: '#/components/schemas/CreateSdnRequest'
9334 $ref: '#/components/schemas/CreateSdnRequest'
9339 $ref: '#/components/schemas/EditSdnRequest'
9342 $ref: '#/components/schemas/EditSdnRequest'
9347 $ref: '#/components/schemas/CreatePduRequest'
9350 $ref: '#/components/schemas/CreatePduRequest'
9355 $ref: '#/components/schemas/EditPduRequest'
9358 $ref: '#/components/schemas/EditPduRequest'
9359 CreateK8sClusterRequest:
9363 $ref: '#/components/schemas/CreateK8sClusterRequest'
9366 $ref: '#/components/schemas/CreateK8sClusterRequest'
9367 EditK8sClusterRequest:
9371 $ref: '#/components/schemas/EditK8sClusterRequest'
9374 $ref: '#/components/schemas/EditK8sClusterRequest'
9379 $ref: '#/components/schemas/CreateVcaRequest'
9382 $ref: '#/components/schemas/CreateVcaRequest'
9387 $ref: '#/components/schemas/EditVcaRequest'
9390 $ref: '#/components/schemas/EditVcaRequest'
9391 CreateK8sRepoRequest:
9395 $ref: '#/components/schemas/CreateK8sRepoRequest'
9398 $ref: '#/components/schemas/CreateK8sRepoRequest'
9399 NslcmSubscriptionRequest:
9403 $ref: '#/components/schemas/NslcmSubscriptionRequest'
9406 $ref: '#/components/schemas/NslcmSubscriptionRequest'
9407 # END REQUEST BODIES