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
1413 summary: Read an individual NS instance resource
1414 description: Read an individual NS instance resource
1415 operationId: getNSinstance
1422 $ref: '#/components/schemas/NsInstance'
1425 $ref: '#/components/schemas/NsInstance'
1427 $ref: '#/components/responses/BadRequest'
1429 $ref: '#/components/responses/Unauthorized'
1431 $ref: '#/components/responses/Forbidden'
1433 $ref: '#/components/responses/NotFound'
1435 $ref: '#/components/responses/MethodNotAllowed'
1437 $ref: '#/components/responses/NotAcceptable'
1439 $ref: '#/components/responses/Conflict'
1441 $ref: '#/components/responses/UnprocessableEntity'
1443 $ref: '#/components/responses/InternalServerError'
1445 $ref: '#/components/responses/ServiceUnavailable'
1447 $ref: '#/components/responses/UnexpectedError'
1449 $ref: '#/components/responses/UnexpectedError'
1453 summary: Delete an individual NS instance resource
1454 description: Delete an individual NS instance resource
1455 operationId: deleteNSinstance
1458 description: No Content
1460 $ref: '#/components/responses/BadRequest'
1462 $ref: '#/components/responses/Unauthorized'
1464 $ref: '#/components/responses/Forbidden'
1466 $ref: '#/components/responses/NotFound'
1468 $ref: '#/components/responses/MethodNotAllowed'
1470 $ref: '#/components/responses/NotAcceptable'
1472 $ref: '#/components/responses/Conflict'
1474 $ref: '#/components/responses/UnprocessableEntity'
1476 $ref: '#/components/responses/InternalServerError'
1478 $ref: '#/components/responses/ServiceUnavailable'
1480 $ref: '#/components/responses/UnexpectedError'
1482 $ref: '#/components/responses/UnexpectedError'
1483 '/nslcm/v1/ns_instances/{nsInstanceId}/instantiate':
1485 - name: nsInstanceId
1488 description: NS Instance ID
1494 summary: Instantiate a NS
1496 Instantiate a NS. The precondition is that the NS instance must have
1497 been created and must be in NOT_INSTANTIATED state. As a result of the
1498 success of this operation, the NFVO creates a "NS Lifecycle Operation
1499 Occurrence" resource for the request, and the NS instance state becomes
1501 operationId: instantiateNSinstance
1503 $ref: '#/components/requestBodies/InstantiateNsRequest'
1506 description: Accepted
1510 It must point to the new "NS Lifecycle Operation Occurrence"
1511 resource, i.e. an URI like ".../ns_lcm_op_occs/{nsLcmOpOccId}"
1518 $ref: '#/components/schemas/ObjectId'
1521 $ref: '#/components/schemas/ObjectId'
1523 $ref: '#/components/responses/BadRequest'
1525 $ref: '#/components/responses/Unauthorized'
1527 $ref: '#/components/responses/Forbidden'
1529 $ref: '#/components/responses/NotFound'
1531 $ref: '#/components/responses/MethodNotAllowed'
1533 $ref: '#/components/responses/NotAcceptable'
1535 $ref: '#/components/responses/Conflict'
1537 $ref: '#/components/responses/UnprocessableEntity'
1539 $ref: '#/components/responses/InternalServerError'
1541 $ref: '#/components/responses/ServiceUnavailable'
1543 $ref: '#/components/responses/UnexpectedError'
1545 $ref: '#/components/responses/UnexpectedError'
1546 '/nslcm/v1/ns_instances/{nsInstanceId}/scale':
1548 - name: nsInstanceId
1551 description: NS Instance ID
1557 summary: Scale a NS instance
1559 Scale a NS instance. The precondition is that the NS instance must have
1560 been created and must be in INSTANTIATED state. As a result of the
1561 success of this operation, the NFVO creates a "NS Lifecycle Operation
1562 Occurrence" resource for the request, and the NS instance state remains
1564 operationId: scaleNSinstance
1566 $ref: '#/components/requestBodies/ScaleNsRequest'
1569 description: Accepted
1573 It must point to the new "NS Lifecycle Operation Occurrence"
1574 resource, i.e. an URI like ".../ns_lcm_op_occs/{nsLcmOpOccId}"
1579 $ref: '#/components/responses/BadRequest'
1581 $ref: '#/components/responses/Unauthorized'
1583 $ref: '#/components/responses/Forbidden'
1585 $ref: '#/components/responses/NotFound'
1587 $ref: '#/components/responses/MethodNotAllowed'
1589 $ref: '#/components/responses/NotAcceptable'
1591 $ref: '#/components/responses/Conflict'
1593 $ref: '#/components/responses/UnprocessableEntity'
1595 $ref: '#/components/responses/InternalServerError'
1597 $ref: '#/components/responses/ServiceUnavailable'
1599 $ref: '#/components/responses/UnexpectedError'
1601 $ref: '#/components/responses/UnexpectedError'
1602 '/nslcm/v1/ns_instances/{nsInstanceId}/terminate':
1604 - name: nsInstanceId
1607 description: NS Instance ID
1613 summary: Terminate a NS instance
1615 Terminate a NS instance. The precondition is that the NS instance must have
1616 been created and must be in INSTANTIATED state. As a result of the
1617 success of this operation, the NFVO creates a "NS Lifecycle Operation
1618 Occurrence" resource for the request, and the NS instance state becomes
1620 operationId: terminateNSinstance
1622 # Request data is not required
1623 $ref: '#/components/requestBodies/TerminateNsRequest'
1626 description: Accepted
1630 It must point to the new "NS Lifecycle Operation Occurrence"
1631 resource, i.e. an URI like ".../ns_lcm_op_occs/{nsLcmOpOccId}"
1638 $ref: '#/components/schemas/ObjectId'
1641 $ref: '#/components/schemas/ObjectId'
1643 $ref: '#/components/responses/BadRequest'
1645 $ref: '#/components/responses/Unauthorized'
1647 $ref: '#/components/responses/Forbidden'
1649 $ref: '#/components/responses/NotFound'
1651 $ref: '#/components/responses/MethodNotAllowed'
1653 $ref: '#/components/responses/NotAcceptable'
1655 $ref: '#/components/responses/Conflict'
1657 $ref: '#/components/responses/UnprocessableEntity'
1659 $ref: '#/components/responses/InternalServerError'
1661 $ref: '#/components/responses/ServiceUnavailable'
1663 $ref: '#/components/responses/UnexpectedError'
1665 $ref: '#/components/responses/UnexpectedError'
1666 '/nslcm/v1/ns_instances/{nsInstanceId}/action':
1668 - name: nsInstanceId
1671 description: NS Instance ID
1677 summary: Execute an action on a NS instance
1679 Execute an action on a NS instance.
1680 The NS instance must have been created and must be in INSTANTIATED state.
1681 operationId: actionOnNSinstance
1686 $ref: '#/components/schemas/NSinstanceActionRequest'
1689 $ref: '#/components/schemas/NSinstanceActionRequest'
1692 description: Accepted
1696 It must point to the new "NS Lifecycle Operation Occurrence"
1697 resource, i.e. an URI like ".../ns_lcm_op_occs/{nsLcmOpOccId}"
1704 $ref: '#/components/schemas/ObjectId'
1707 $ref: '#/components/schemas/ObjectId'
1709 $ref: '#/components/responses/BadRequest'
1711 $ref: '#/components/responses/Unauthorized'
1713 $ref: '#/components/responses/Forbidden'
1715 $ref: '#/components/responses/NotFound'
1717 $ref: '#/components/responses/MethodNotAllowed'
1719 $ref: '#/components/responses/NotAcceptable'
1721 $ref: '#/components/responses/Conflict'
1723 $ref: '#/components/responses/UnprocessableEntity'
1725 $ref: '#/components/responses/InternalServerError'
1727 $ref: '#/components/responses/ServiceUnavailable'
1729 $ref: '#/components/responses/UnexpectedError'
1731 $ref: '#/components/responses/UnexpectedError'
1732 '/nslcm/v1/ns_instances_content':
1736 summary: Query information about multiple NS instances
1737 description: Query information about multiple NS isntances
1738 operationId: getNSinstancesContent
1745 $ref: '#/components/schemas/ArrayOfNsInstance'
1748 $ref: '#/components/schemas/ArrayOfNsInstance'
1750 $ref: '#/components/responses/BadRequest'
1752 $ref: '#/components/responses/Unauthorized'
1754 $ref: '#/components/responses/Forbidden'
1756 $ref: '#/components/responses/NotFound'
1758 $ref: '#/components/responses/MethodNotAllowed'
1760 $ref: '#/components/responses/NotAcceptable'
1762 $ref: '#/components/responses/Conflict'
1764 $ref: '#/components/responses/UnprocessableEntity'
1766 $ref: '#/components/responses/InternalServerError'
1768 $ref: '#/components/responses/ServiceUnavailable'
1770 $ref: '#/components/responses/UnexpectedError'
1772 $ref: '#/components/responses/UnexpectedError'
1776 summary: Create a new NS instance
1777 description: Create a new NS instance
1778 operationId: createNSinstanceContent
1780 $ref: '#/components/requestBodies/InstantiateNsRequest'
1783 description: Created
1792 $ref: '#/components/schemas/CreateNSinstanceContentResponse'
1795 $ref: '#/components/schemas/CreateNSinstanceContentResponse'
1797 $ref: '#/components/responses/BadRequest'
1799 $ref: '#/components/responses/Unauthorized'
1801 $ref: '#/components/responses/Forbidden'
1803 $ref: '#/components/responses/NotFound'
1805 $ref: '#/components/responses/MethodNotAllowed'
1807 $ref: '#/components/responses/NotAcceptable'
1809 $ref: '#/components/responses/Conflict'
1811 $ref: '#/components/responses/UnprocessableEntity'
1813 $ref: '#/components/responses/InternalServerError'
1815 $ref: '#/components/responses/ServiceUnavailable'
1817 $ref: '#/components/responses/UnexpectedError'
1819 $ref: '#/components/responses/UnexpectedError'
1820 '/nslcm/v1/ns_instances_content/{nsInstanceContentId}':
1822 - name: nsInstanceContentId
1825 description: NS Instance Content ID
1831 summary: Read an individual NS instance resource
1832 description: Read an individual NS instance resource
1833 operationId: getNSinstanceContent
1840 $ref: '#/components/schemas/NsInstance'
1843 $ref: '#/components/schemas/NsInstance'
1845 $ref: '#/components/responses/BadRequest'
1847 $ref: '#/components/responses/Unauthorized'
1849 $ref: '#/components/responses/Forbidden'
1851 $ref: '#/components/responses/NotFound'
1853 $ref: '#/components/responses/MethodNotAllowed'
1855 $ref: '#/components/responses/NotAcceptable'
1857 $ref: '#/components/responses/Conflict'
1859 $ref: '#/components/responses/UnprocessableEntity'
1861 $ref: '#/components/responses/InternalServerError'
1863 $ref: '#/components/responses/ServiceUnavailable'
1865 $ref: '#/components/responses/UnexpectedError'
1867 $ref: '#/components/responses/UnexpectedError'
1871 summary: Delete an individual NS instance resource
1872 description: Delete an individual NS instance resource
1873 operationId: deleteNSinstanceContent
1876 description: Accepted
1880 $ref: '#/components/schemas/ObjectId'
1883 $ref: '#/components/schemas/ObjectId'
1885 description: No Content
1887 $ref: '#/components/responses/BadRequest'
1889 $ref: '#/components/responses/Unauthorized'
1891 $ref: '#/components/responses/Forbidden'
1893 $ref: '#/components/responses/NotFound'
1895 $ref: '#/components/responses/MethodNotAllowed'
1897 $ref: '#/components/responses/NotAcceptable'
1899 $ref: '#/components/responses/Conflict'
1901 $ref: '#/components/responses/UnprocessableEntity'
1903 $ref: '#/components/responses/InternalServerError'
1905 $ref: '#/components/responses/ServiceUnavailable'
1907 $ref: '#/components/responses/UnexpectedError'
1909 $ref: '#/components/responses/UnexpectedError'
1910 '/nslcm/v1/ns_lcm_op_occs':
1914 summary: Query information about multiple NS LCM Operation Occurrences
1915 description: Query information about multiple NS LCM Operation Occurrences
1916 operationId: getNSLCMOpOccs
1923 $ref: '#/components/schemas/ArrayOfNsLcmOpOcc'
1926 $ref: '#/components/schemas/ArrayOfNsLcmOpOcc'
1928 $ref: '#/components/responses/BadRequest'
1930 $ref: '#/components/responses/Unauthorized'
1932 $ref: '#/components/responses/Forbidden'
1934 $ref: '#/components/responses/NotFound'
1936 $ref: '#/components/responses/MethodNotAllowed'
1938 $ref: '#/components/responses/NotAcceptable'
1940 $ref: '#/components/responses/Conflict'
1942 $ref: '#/components/responses/UnprocessableEntity'
1944 $ref: '#/components/responses/InternalServerError'
1946 $ref: '#/components/responses/ServiceUnavailable'
1948 $ref: '#/components/responses/UnexpectedError'
1950 $ref: '#/components/responses/UnexpectedError'
1951 '/nslcm/v1/ns_lcm_op_occs/{nsLcmOpOccId}':
1953 - name: nsLcmOpOccId
1956 description: NS LCM Operation Occurrence ID
1962 summary: Query information about an individual NS LCM Operation Occurrence
1963 description: Query information about an individual NS LCM Operation Occurrence
1964 operationId: getNSLCMOpOcc
1971 $ref: '#/components/schemas/NsLcmOpOcc'
1974 $ref: '#/components/schemas/NsLcmOpOcc'
1976 $ref: '#/components/responses/BadRequest'
1978 $ref: '#/components/responses/Unauthorized'
1980 $ref: '#/components/responses/Forbidden'
1982 $ref: '#/components/responses/NotFound'
1984 $ref: '#/components/responses/MethodNotAllowed'
1986 $ref: '#/components/responses/NotAcceptable'
1988 $ref: '#/components/responses/Conflict'
1990 $ref: '#/components/responses/UnprocessableEntity'
1992 $ref: '#/components/responses/InternalServerError'
1994 $ref: '#/components/responses/ServiceUnavailable'
1996 $ref: '#/components/responses/UnexpectedError'
1998 $ref: '#/components/responses/UnexpectedError'
1999 '/nslcm/v1/vnf_instances':
2003 summary: Query information about multiple VNF Instances
2004 description: Query information about multiple VNF Instances
2005 operationId: getVnfInstances
2012 $ref: '#/components/schemas/ArrayOfVnfInstanceInfo'
2015 $ref: '#/components/schemas/ArrayOfVnfInstanceInfo'
2017 $ref: '#/components/responses/BadRequest'
2019 $ref: '#/components/responses/Unauthorized'
2021 $ref: '#/components/responses/Forbidden'
2023 $ref: '#/components/responses/NotFound'
2025 $ref: '#/components/responses/MethodNotAllowed'
2027 $ref: '#/components/responses/NotAcceptable'
2029 $ref: '#/components/responses/Conflict'
2031 $ref: '#/components/responses/UnprocessableEntity'
2033 $ref: '#/components/responses/InternalServerError'
2035 $ref: '#/components/responses/ServiceUnavailable'
2037 $ref: '#/components/responses/UnexpectedError'
2039 $ref: '#/components/responses/UnexpectedError'
2040 '/nslcm/v1/vnf_instances/{vnfInstanceId}':
2042 - name: vnfInstanceId
2045 description: VNF Instance ID
2051 summary: Query information about an individual VNF Instance
2052 description: Query information about an individual VNF Instance
2053 operationId: getVnfInstance
2060 $ref: '#/components/schemas/VnfInstanceInfo'
2063 $ref: '#/components/schemas/VnfInstanceInfo'
2065 $ref: '#/components/responses/BadRequest'
2067 $ref: '#/components/responses/Unauthorized'
2069 $ref: '#/components/responses/Forbidden'
2071 $ref: '#/components/responses/NotFound'
2073 $ref: '#/components/responses/MethodNotAllowed'
2075 $ref: '#/components/responses/NotAcceptable'
2077 $ref: '#/components/responses/Conflict'
2079 $ref: '#/components/responses/UnprocessableEntity'
2081 $ref: '#/components/responses/InternalServerError'
2083 $ref: '#/components/responses/ServiceUnavailable'
2085 $ref: '#/components/responses/UnexpectedError'
2087 $ref: '#/components/responses/UnexpectedError'
2090 # BEGIN NetSlice Templates
2091 '/nst/v1/netslice_templates':
2094 - "NetSlice templates"
2095 summary: Query information about multiple NetSlice template resources
2096 description: Query information about multiple NetSlice template resources
2097 operationId: getNSTs
2104 $ref: '#/components/schemas/ArrayOfNstInfo'
2107 $ref: '#/components/schemas/ArrayOfNstInfo'
2109 $ref: '#/components/responses/BadRequest'
2111 $ref: '#/components/responses/Unauthorized'
2113 $ref: '#/components/responses/Forbidden'
2115 $ref: '#/components/responses/NotFound'
2117 $ref: '#/components/responses/MethodNotAllowed'
2119 $ref: '#/components/responses/NotAcceptable'
2121 $ref: '#/components/responses/Conflict'
2123 $ref: '#/components/responses/UnprocessableEntity'
2125 $ref: '#/components/responses/InternalServerError'
2127 $ref: '#/components/responses/ServiceUnavailable'
2129 $ref: '#/components/responses/UnexpectedError'
2131 $ref: '#/components/responses/UnexpectedError'
2134 - "NetSlice templates"
2135 summary: Create a new NetSlice template resource
2136 description: Create a new NetSlice template resource
2139 $ref: '#/components/requestBodies/CreateNstInfoRequest'
2142 description: Created
2151 $ref: '#/components/schemas/ObjectId'
2154 $ref: '#/components/schemas/ObjectId'
2156 $ref: '#/components/responses/BadRequest'
2158 $ref: '#/components/responses/Unauthorized'
2160 $ref: '#/components/responses/Forbidden'
2162 $ref: '#/components/responses/NotFound'
2164 $ref: '#/components/responses/MethodNotAllowed'
2166 $ref: '#/components/responses/NotAcceptable'
2168 $ref: '#/components/responses/Conflict'
2170 $ref: '#/components/responses/UnprocessableEntity'
2172 $ref: '#/components/responses/InternalServerError'
2174 $ref: '#/components/responses/ServiceUnavailable'
2176 $ref: '#/components/responses/UnexpectedError'
2178 $ref: '#/components/responses/UnexpectedError'
2179 '/nst/v1/netslice_templates/{netsliceTemplateId}':
2181 - name: netsliceTemplateId
2184 description: NetSlice Template ID
2189 - "NetSlice templates"
2190 summary: Read information about an individual NetSlice template resource
2191 description: Read information about an individual NetSlice template resource
2199 $ref: '#/components/schemas/NstInfo'
2202 $ref: '#/components/schemas/NstInfo'
2204 $ref: '#/components/responses/BadRequest'
2206 $ref: '#/components/responses/Unauthorized'
2208 $ref: '#/components/responses/Forbidden'
2210 $ref: '#/components/responses/NotFound'
2212 $ref: '#/components/responses/MethodNotAllowed'
2214 $ref: '#/components/responses/NotAcceptable'
2216 $ref: '#/components/responses/Conflict'
2218 $ref: '#/components/responses/UnprocessableEntity'
2220 $ref: '#/components/responses/InternalServerError'
2222 $ref: '#/components/responses/ServiceUnavailable'
2224 $ref: '#/components/responses/UnexpectedError'
2226 $ref: '#/components/responses/UnexpectedError'
2229 - "NetSlice templates"
2230 summary: Delete an individual NetSlice template resource
2231 description: Delete an individual NetSlice template resource
2232 operationId: deleteNST
2235 description: No Content
2237 $ref: '#/components/responses/BadRequest'
2239 $ref: '#/components/responses/Unauthorized'
2241 $ref: '#/components/responses/Forbidden'
2243 $ref: '#/components/responses/NotFound'
2245 $ref: '#/components/responses/MethodNotAllowed'
2247 $ref: '#/components/responses/NotAcceptable'
2249 $ref: '#/components/responses/Conflict'
2251 $ref: '#/components/responses/UnprocessableEntity'
2253 $ref: '#/components/responses/InternalServerError'
2255 $ref: '#/components/responses/ServiceUnavailable'
2257 $ref: '#/components/responses/UnexpectedError'
2259 $ref: '#/components/responses/UnexpectedError'
2260 '/nst/v1/netslice_templates/{netsliceTemplateId}/artifacts/{artifactPath}':
2262 - name: netsliceTemplateId
2265 description: NetSlice Template ID
2268 - name: artifactPath
2271 description: Artifact Path
2276 - "NetSlice templates"
2277 summary: Fetch individual NetSlice Template artifact
2278 description: Fetch individual NetSlice Template artifact
2279 operationId: getNstArtifact
2284 application/octet-stream:
2289 description: Partial Content
2295 application/octet-stream:
2300 $ref: '#/components/responses/BadRequest'
2302 $ref: '#/components/responses/Unauthorized'
2304 $ref: '#/components/responses/Forbidden'
2306 $ref: '#/components/responses/NotFound'
2308 $ref: '#/components/responses/MethodNotAllowed'
2310 $ref: '#/components/responses/NotAcceptable'
2312 $ref: '#/components/responses/Conflict'
2314 $ref: '#/components/responses/UnprocessableEntity'
2316 $ref: '#/components/responses/InternalServerError'
2318 $ref: '#/components/responses/ServiceUnavailable'
2320 $ref: '#/components/responses/UnexpectedError'
2322 $ref: '#/components/responses/UnexpectedError'
2323 '/nst/v1/netslice_templates/{netsliceTemplateId}/nst':
2325 - name: netsliceTemplateId
2328 description: NetSlice Template ID
2333 - "NetSlice templates"
2334 summary: Read NST of an on-boarded NetSlice Template
2335 description: Read NST of an on-boarded NetSlice Template
2336 operationId: getNstNst
2343 $ref: '#/components/schemas/NetSliceTemplate'
2345 $ref: '#/components/responses/BadRequest'
2347 $ref: '#/components/responses/Unauthorized'
2349 $ref: '#/components/responses/Forbidden'
2351 $ref: '#/components/responses/NotFound'
2353 $ref: '#/components/responses/MethodNotAllowed'
2355 $ref: '#/components/responses/NotAcceptable'
2357 $ref: '#/components/responses/Conflict'
2359 $ref: '#/components/responses/UnprocessableEntity'
2361 $ref: '#/components/responses/InternalServerError'
2363 $ref: '#/components/responses/ServiceUnavailable'
2365 $ref: '#/components/responses/UnexpectedError'
2367 $ref: '#/components/responses/UnexpectedError'
2368 '/nst/v1/netslice_templates/{netsliceTemplateId}/nst_content':
2370 - name: netsliceTemplateId
2373 description: NetSlice Template ID
2378 - "NetSlice templates"
2379 summary: Fetch the content of a NST
2380 description: Fetch the content of a NST
2381 operationId: getNSTcontent
2388 $ref: '#/components/schemas/NetSlicePackage'
2390 description: Partial Content
2398 $ref: '#/components/schemas/NetSlicePackage'
2400 $ref: '#/components/responses/BadRequest'
2402 $ref: '#/components/responses/Unauthorized'
2404 $ref: '#/components/responses/Forbidden'
2406 $ref: '#/components/responses/NotFound'
2408 $ref: '#/components/responses/MethodNotAllowed'
2410 $ref: '#/components/responses/NotAcceptable'
2412 $ref: '#/components/responses/Conflict'
2414 $ref: '#/components/responses/UnprocessableEntity'
2416 $ref: '#/components/responses/InternalServerError'
2418 $ref: '#/components/responses/ServiceUnavailable'
2420 $ref: '#/components/responses/UnexpectedError'
2422 $ref: '#/components/responses/UnexpectedError'
2425 - "NetSlice templates"
2426 summary: Upload the content of a NST
2427 description: Upload the content of a NST
2428 operationId: updateNSTcontent
2430 $ref: '#/components/requestBodies/NetSlicePackage'
2433 description: Accepted
2435 description: No Content
2437 $ref: '#/components/responses/BadRequest'
2439 $ref: '#/components/responses/Unauthorized'
2441 $ref: '#/components/responses/Forbidden'
2443 $ref: '#/components/responses/NotFound'
2445 $ref: '#/components/responses/MethodNotAllowed'
2447 $ref: '#/components/responses/NotAcceptable'
2449 $ref: '#/components/responses/Conflict'
2451 $ref: '#/components/responses/UnprocessableEntity'
2453 $ref: '#/components/responses/InternalServerError'
2455 $ref: '#/components/responses/ServiceUnavailable'
2457 $ref: '#/components/responses/UnexpectedError'
2459 $ref: '#/components/responses/UnexpectedError'
2460 '/nst/v1/netslice_templates_content':
2463 - "NetSlice templates"
2464 summary: Upload a NetSlice package by providing the content of the NetSlice package
2465 description: Upload a NetSlice package by providing the content of the NetSlice package
2466 operationId: uploadNstContent
2471 $ref: '#/components/schemas/NetSlicePackage'
2474 description: Created
2483 $ref: '#/components/schemas/ObjectId'
2486 $ref: '#/components/schemas/ObjectId'
2488 description: Accepted
2490 description: No Content
2492 $ref: '#/components/responses/BadRequest'
2494 $ref: '#/components/responses/Unauthorized'
2496 $ref: '#/components/responses/Forbidden'
2498 $ref: '#/components/responses/NotFound'
2500 $ref: '#/components/responses/MethodNotAllowed'
2502 $ref: '#/components/responses/NotAcceptable'
2504 $ref: '#/components/responses/Conflict'
2506 $ref: '#/components/responses/UnprocessableEntity'
2508 $ref: '#/components/responses/InternalServerError'
2510 $ref: '#/components/responses/ServiceUnavailable'
2512 $ref: '#/components/responses/UnexpectedError'
2514 $ref: '#/components/responses/UnexpectedError'
2517 - "NetSlice templates"
2518 summary: Query information about multiple NetSlice Template resources
2519 description: Query information about multiple NetSlice Template resources
2520 operationId: getNstContent
2527 $ref: '#/components/schemas/ArrayOfNstInfo'
2530 $ref: '#/components/schemas/ArrayOfNstInfo'
2532 description: Partial Content
2538 application/octet-stream:
2543 $ref: '#/components/responses/BadRequest'
2545 $ref: '#/components/responses/Unauthorized'
2547 $ref: '#/components/responses/Forbidden'
2549 $ref: '#/components/responses/NotFound'
2551 $ref: '#/components/responses/MethodNotAllowed'
2553 $ref: '#/components/responses/NotAcceptable'
2555 $ref: '#/components/responses/Conflict'
2557 $ref: '#/components/responses/UnprocessableEntity'
2559 $ref: '#/components/responses/InternalServerError'
2561 $ref: '#/components/responses/ServiceUnavailable'
2563 $ref: '#/components/responses/UnexpectedError'
2565 $ref: '#/components/responses/UnexpectedError'
2566 '/nst/v1/netslice_templates_content/{netsliceTemplateContentId}':
2568 - name: netsliceTemplateContentId
2571 description: NetSlice Template ID
2576 - "NetSlice templates"
2577 summary: Read information about an individual NetSlice Template resource
2578 description: Read information about an individual NetSlice Template resource
2579 operationId: getNstIdContent
2586 $ref: '#/components/schemas/NstInfo'
2589 $ref: '#/components/schemas/NstInfo'
2591 $ref: '#/components/responses/BadRequest'
2593 $ref: '#/components/responses/Unauthorized'
2595 $ref: '#/components/responses/Forbidden'
2597 $ref: '#/components/responses/NotFound'
2599 $ref: '#/components/responses/MethodNotAllowed'
2601 $ref: '#/components/responses/NotAcceptable'
2603 $ref: '#/components/responses/Conflict'
2605 $ref: '#/components/responses/UnprocessableEntity'
2607 $ref: '#/components/responses/InternalServerError'
2609 $ref: '#/components/responses/ServiceUnavailable'
2611 $ref: '#/components/responses/UnexpectedError'
2613 $ref: '#/components/responses/UnexpectedError'
2616 - "NetSlice templates"
2617 summary: Modify an individual NetSlice Template resource
2618 description: Modify an individual NetSlice Template resource
2619 operationId: updateNstIdContent
2621 $ref: '#/components/requestBodies/NstInfoModifications'
2624 description: No Content
2626 $ref: '#/components/responses/BadRequest'
2628 $ref: '#/components/responses/Unauthorized'
2630 $ref: '#/components/responses/Forbidden'
2632 $ref: '#/components/responses/NotFound'
2634 $ref: '#/components/responses/MethodNotAllowed'
2636 $ref: '#/components/responses/NotAcceptable'
2638 $ref: '#/components/responses/Conflict'
2640 $ref: '#/components/responses/UnprocessableEntity'
2642 $ref: '#/components/responses/InternalServerError'
2644 $ref: '#/components/responses/ServiceUnavailable'
2646 $ref: '#/components/responses/UnexpectedError'
2648 $ref: '#/components/responses/UnexpectedError'
2651 - "NetSlice templates"
2652 summary: Delete an individual NetSlice Template resource
2653 description: Delete an individual NetSlice Template resource
2654 operationId: deleteNstIdContent
2657 description: No Content
2659 $ref: '#/components/responses/BadRequest'
2661 $ref: '#/components/responses/Unauthorized'
2663 $ref: '#/components/responses/Forbidden'
2665 $ref: '#/components/responses/NotFound'
2667 $ref: '#/components/responses/MethodNotAllowed'
2669 $ref: '#/components/responses/NotAcceptable'
2671 $ref: '#/components/responses/Conflict'
2673 $ref: '#/components/responses/UnprocessableEntity'
2675 $ref: '#/components/responses/InternalServerError'
2677 $ref: '#/components/responses/ServiceUnavailable'
2679 $ref: '#/components/responses/UnexpectedError'
2681 $ref: '#/components/responses/UnexpectedError'
2682 # END NetSlice Templates
2684 # BEGIN NetSlice Instances
2685 '/nsilcm/v1/netslice_instances':
2688 - "NetSlice instances"
2689 summary: Query information about multiple NetSlice instances
2690 description: Query information about multiple NetSlice isntances
2691 operationId: getNSIs
2698 $ref: '#/components/schemas/ArrayOfNetSliceInstance'
2701 $ref: '#/components/schemas/ArrayOfNetSliceInstance'
2703 $ref: '#/components/responses/BadRequest'
2705 $ref: '#/components/responses/Unauthorized'
2707 $ref: '#/components/responses/Forbidden'
2709 $ref: '#/components/responses/NotFound'
2711 $ref: '#/components/responses/MethodNotAllowed'
2713 $ref: '#/components/responses/NotAcceptable'
2715 $ref: '#/components/responses/Conflict'
2717 $ref: '#/components/responses/UnprocessableEntity'
2719 $ref: '#/components/responses/InternalServerError'
2721 $ref: '#/components/responses/ServiceUnavailable'
2723 $ref: '#/components/responses/UnexpectedError'
2725 $ref: '#/components/responses/UnexpectedError'
2728 - "NetSlice instances"
2729 summary: Create a new NetSlice instance resource
2730 description: Create a new NetSlice instance resource
2733 $ref: '#/components/requestBodies/InstantiateNsiRequest'
2736 description: Created
2745 $ref: '#/components/schemas/ObjectId'
2748 $ref: '#/components/schemas/ObjectId'
2750 $ref: '#/components/responses/BadRequest'
2752 $ref: '#/components/responses/Unauthorized'
2754 $ref: '#/components/responses/Forbidden'
2756 $ref: '#/components/responses/NotFound'
2758 $ref: '#/components/responses/MethodNotAllowed'
2760 $ref: '#/components/responses/NotAcceptable'
2762 $ref: '#/components/responses/Conflict'
2764 $ref: '#/components/responses/UnprocessableEntity'
2766 $ref: '#/components/responses/InternalServerError'
2768 $ref: '#/components/responses/ServiceUnavailable'
2770 $ref: '#/components/responses/UnexpectedError'
2772 $ref: '#/components/responses/UnexpectedError'
2773 '/nsilcm/v1/netslice_instances/{netsliceInstanceId}':
2775 - name: netsliceInstanceId
2778 description: NetSlice Instance ID
2783 - "NetSlice instances"
2784 summary: Read an individual NetSlice instance resource
2785 description: Read an individual NetSlice instance resource
2793 $ref: '#/components/schemas/NetSliceInstance'
2796 $ref: '#/components/schemas/NetSliceInstance'
2798 $ref: '#/components/responses/BadRequest'
2800 $ref: '#/components/responses/Unauthorized'
2802 $ref: '#/components/responses/Forbidden'
2804 $ref: '#/components/responses/NotFound'
2806 $ref: '#/components/responses/MethodNotAllowed'
2808 $ref: '#/components/responses/NotAcceptable'
2810 $ref: '#/components/responses/Conflict'
2812 $ref: '#/components/responses/UnprocessableEntity'
2814 $ref: '#/components/responses/InternalServerError'
2816 $ref: '#/components/responses/ServiceUnavailable'
2818 $ref: '#/components/responses/UnexpectedError'
2820 $ref: '#/components/responses/UnexpectedError'
2823 - "NetSlice instances"
2824 summary: Delete an individual NetSlice instance resource
2825 description: Delete an individual NetSlice instance resource
2826 operationId: deleteNSI
2829 description: No Content
2831 $ref: '#/components/responses/BadRequest'
2833 $ref: '#/components/responses/Unauthorized'
2835 $ref: '#/components/responses/Forbidden'
2837 $ref: '#/components/responses/NotFound'
2839 $ref: '#/components/responses/MethodNotAllowed'
2841 $ref: '#/components/responses/NotAcceptable'
2843 $ref: '#/components/responses/Conflict'
2845 $ref: '#/components/responses/UnprocessableEntity'
2847 $ref: '#/components/responses/InternalServerError'
2849 $ref: '#/components/responses/ServiceUnavailable'
2851 $ref: '#/components/responses/UnexpectedError'
2853 $ref: '#/components/responses/UnexpectedError'
2854 '/nsilcm/v1/netslice_instances/{netsliceInstanceId}/instantiate':
2856 - name: netsliceInstanceId
2859 description: NetSlice Instance ID
2864 - "NetSlice instances"
2865 summary: Instantiate a NetSlice
2867 Instantiate a NetSlice. The precondition is that the NetSlice instance
2868 must have been created and must be in NOT_INSTANTIATED state. As a result
2869 of the success of this operation, the NFVO creates a "NetSlice Lifecycle
2870 Operation Occurrence" resource for the request, and the NS instance state
2871 becomes INSTANTIATED.
2872 operationId: instantiateNSI
2874 $ref: '#/components/requestBodies/InstantiateNsiRequest'
2877 description: Accepted
2881 It must point to the new "NetSlice Lifecycle Operation Occurrence"
2882 resource, i.e. an URI like ".../nsi_lcm_op_occs/{nsiLcmOpOccId}"
2889 $ref: '#/components/schemas/ObjectId'
2892 $ref: '#/components/schemas/ObjectId'
2894 $ref: '#/components/responses/BadRequest'
2896 $ref: '#/components/responses/Unauthorized'
2898 $ref: '#/components/responses/Forbidden'
2900 $ref: '#/components/responses/NotFound'
2902 $ref: '#/components/responses/MethodNotAllowed'
2904 $ref: '#/components/responses/NotAcceptable'
2906 $ref: '#/components/responses/Conflict'
2908 $ref: '#/components/responses/UnprocessableEntity'
2910 $ref: '#/components/responses/InternalServerError'
2912 $ref: '#/components/responses/ServiceUnavailable'
2914 $ref: '#/components/responses/UnexpectedError'
2916 $ref: '#/components/responses/UnexpectedError'
2917 '/nsilcm/v1/netslice_instances/{netsliceInstanceId}/terminate':
2919 - name: netsliceInstanceId
2922 description: NetSlice Instance ID
2927 - "NetSlice instances"
2928 summary: Terminate a NetSlice instance
2930 Terminate a NetSlice instance. The precondition is that the NetSlice instance
2931 must have been created and must be in INSTANTIATED state. As a result of the
2932 success of this operation, the NFVO creates a "NetSlice Lifecycle Operation
2933 Occurrence" resource for the request, and the NetSlice instance state becomes
2935 operationId: terminateNSI
2937 # Request data is not required
2938 $ref: '#/components/requestBodies/TerminateNsiRequest'
2941 description: Accepted
2945 It must point to the new "NetSlice Lifecycle Operation Occurrence"
2946 resource, i.e. an URI like ".../nsi_lcm_op_occs/{nsiLcmOpOccId}"
2953 $ref: '#/components/schemas/ObjectId'
2956 $ref: '#/components/schemas/ObjectId'
2958 $ref: '#/components/responses/BadRequest'
2960 $ref: '#/components/responses/Unauthorized'
2962 $ref: '#/components/responses/Forbidden'
2964 $ref: '#/components/responses/NotFound'
2966 $ref: '#/components/responses/MethodNotAllowed'
2968 $ref: '#/components/responses/NotAcceptable'
2970 $ref: '#/components/responses/Conflict'
2972 $ref: '#/components/responses/UnprocessableEntity'
2974 $ref: '#/components/responses/InternalServerError'
2976 $ref: '#/components/responses/ServiceUnavailable'
2978 $ref: '#/components/responses/UnexpectedError'
2980 $ref: '#/components/responses/UnexpectedError'
2981 '/nsilcm/v1/netslice_instances/{netsliceInstanceId}/action':
2983 - name: netsliceInstanceId
2986 description: NetSlice Instance ID
2991 - "NetSlice instances"
2992 summary: Execute an action on a NetSlice instance
2994 Execute an action on a NetSlice instance.
2995 The NetSlice instance must have been created and must be in INSTANTIATED state.
2996 operationId: actionOnNSI
3001 $ref: '#/components/schemas/NsiActionRequest'
3004 $ref: '#/components/schemas/NsiActionRequest'
3007 description: Accepted
3011 It must point to the new "NS Lifecycle Operation Occurrence"
3012 resource, i.e. an URI like ".../ns_lcm_op_occs/{nsLcmOpOccId}"
3019 $ref: '#/components/schemas/ObjectId'
3022 $ref: '#/components/schemas/ObjectId'
3024 $ref: '#/components/responses/BadRequest'
3026 $ref: '#/components/responses/Unauthorized'
3028 $ref: '#/components/responses/Forbidden'
3030 $ref: '#/components/responses/NotFound'
3032 $ref: '#/components/responses/MethodNotAllowed'
3034 $ref: '#/components/responses/NotAcceptable'
3036 $ref: '#/components/responses/Conflict'
3038 $ref: '#/components/responses/UnprocessableEntity'
3040 $ref: '#/components/responses/InternalServerError'
3042 $ref: '#/components/responses/ServiceUnavailable'
3044 $ref: '#/components/responses/UnexpectedError'
3046 $ref: '#/components/responses/UnexpectedError'
3047 '/nsilcm/v1/netslice_instances_content':
3050 - "NetSlice instances"
3051 summary: Query information about multiple NetSlice instances
3052 description: Query information about multiple NetSlice isntances
3053 operationId: getNSIsContent
3060 $ref: '#/components/schemas/ArrayOfNetSliceInstance'
3063 $ref: '#/components/schemas/ArrayOfNetSliceInstance'
3065 $ref: '#/components/responses/BadRequest'
3067 $ref: '#/components/responses/Unauthorized'
3069 $ref: '#/components/responses/Forbidden'
3071 $ref: '#/components/responses/NotFound'
3073 $ref: '#/components/responses/MethodNotAllowed'
3075 $ref: '#/components/responses/NotAcceptable'
3077 $ref: '#/components/responses/Conflict'
3079 $ref: '#/components/responses/UnprocessableEntity'
3081 $ref: '#/components/responses/InternalServerError'
3083 $ref: '#/components/responses/ServiceUnavailable'
3085 $ref: '#/components/responses/UnexpectedError'
3087 $ref: '#/components/responses/UnexpectedError'
3090 - "NetSlice instances"
3091 summary: Create a new NetSlice instance
3092 description: Create a new NetSlice instance
3093 operationId: createNSIContent
3095 $ref: '#/components/requestBodies/InstantiateNsiRequest'
3098 description: Created
3107 $ref: '#/components/schemas/CreateNsiContentResponse'
3110 $ref: '#/components/schemas/CreateNsiContentResponse'
3112 $ref: '#/components/responses/BadRequest'
3114 $ref: '#/components/responses/Unauthorized'
3116 $ref: '#/components/responses/Forbidden'
3118 $ref: '#/components/responses/NotFound'
3120 $ref: '#/components/responses/MethodNotAllowed'
3122 $ref: '#/components/responses/NotAcceptable'
3124 $ref: '#/components/responses/Conflict'
3126 $ref: '#/components/responses/UnprocessableEntity'
3128 $ref: '#/components/responses/InternalServerError'
3130 $ref: '#/components/responses/ServiceUnavailable'
3132 $ref: '#/components/responses/UnexpectedError'
3134 $ref: '#/components/responses/UnexpectedError'
3135 '/nsilcm/v1/netslice_instances_content/{netsliceInstanceContentId}':
3137 - name: netsliceInstanceContentId
3140 description: NetSlice Instance Content ID
3145 - "NetSlice instances"
3146 summary: Read an individual NetSlice instance resource
3147 description: Read an individual NetSlice instance resource
3148 operationId: getNSIContent
3155 $ref: '#/components/schemas/NetSliceInstance'
3158 $ref: '#/components/schemas/NetSliceInstance'
3160 $ref: '#/components/responses/BadRequest'
3162 $ref: '#/components/responses/Unauthorized'
3164 $ref: '#/components/responses/Forbidden'
3166 $ref: '#/components/responses/NotFound'
3168 $ref: '#/components/responses/MethodNotAllowed'
3170 $ref: '#/components/responses/NotAcceptable'
3172 $ref: '#/components/responses/Conflict'
3174 $ref: '#/components/responses/UnprocessableEntity'
3176 $ref: '#/components/responses/InternalServerError'
3178 $ref: '#/components/responses/ServiceUnavailable'
3180 $ref: '#/components/responses/UnexpectedError'
3182 $ref: '#/components/responses/UnexpectedError'
3185 - "NetSlice instances"
3186 summary: Delete an individual NS instance resource
3187 description: Delete an individual NS instance resource
3188 operationId: deleteNSIContent
3191 description: Accepted
3195 $ref: '#/components/schemas/ObjectId'
3198 $ref: '#/components/schemas/ObjectId'
3200 description: No Content
3202 $ref: '#/components/responses/BadRequest'
3204 $ref: '#/components/responses/Unauthorized'
3206 $ref: '#/components/responses/Forbidden'
3208 $ref: '#/components/responses/NotFound'
3210 $ref: '#/components/responses/MethodNotAllowed'
3212 $ref: '#/components/responses/NotAcceptable'
3214 $ref: '#/components/responses/Conflict'
3216 $ref: '#/components/responses/UnprocessableEntity'
3218 $ref: '#/components/responses/InternalServerError'
3220 $ref: '#/components/responses/ServiceUnavailable'
3222 $ref: '#/components/responses/UnexpectedError'
3224 $ref: '#/components/responses/UnexpectedError'
3225 '/nsilcm/v1/nsi_lcm_op_occs':
3228 - "NetSlice instances"
3229 summary: Query information about multiple NetSlice LCM Operation Occurrences
3230 description: Query information about multiple NetSlice LCM Operation Occurrences
3231 operationId: getNsiLcmOpOccs
3238 $ref: '#/components/schemas/ArrayOfNsiLcmOpOcc'
3241 $ref: '#/components/schemas/ArrayOfNsiLcmOpOcc'
3243 $ref: '#/components/responses/BadRequest'
3245 $ref: '#/components/responses/Unauthorized'
3247 $ref: '#/components/responses/Forbidden'
3249 $ref: '#/components/responses/NotFound'
3251 $ref: '#/components/responses/MethodNotAllowed'
3253 $ref: '#/components/responses/NotAcceptable'
3255 $ref: '#/components/responses/Conflict'
3257 $ref: '#/components/responses/UnprocessableEntity'
3259 $ref: '#/components/responses/InternalServerError'
3261 $ref: '#/components/responses/ServiceUnavailable'
3263 $ref: '#/components/responses/UnexpectedError'
3265 $ref: '#/components/responses/UnexpectedError'
3266 '/nsilcm/v1/nsi_lcm_op_occs/{nsiLcmOpOccId}':
3268 - name: nsiLcmOpOccId
3271 description: NetSlice LCM Operation Occurrence ID
3276 - "NetSlice instances"
3277 summary: Query information about an individual NetSlice LCM Operation Occurrence
3278 description: Query information about an individual NetSlice LCM Operation Occurrence
3279 operationId: getNsiLcmOpOcc
3286 $ref: '#/components/schemas/NsiLcmOpOcc'
3289 $ref: '#/components/schemas/NsiLcmOpOcc'
3291 $ref: '#/components/responses/BadRequest'
3293 $ref: '#/components/responses/Unauthorized'
3295 $ref: '#/components/responses/Forbidden'
3297 $ref: '#/components/responses/NotFound'
3299 $ref: '#/components/responses/MethodNotAllowed'
3301 $ref: '#/components/responses/NotAcceptable'
3303 $ref: '#/components/responses/Conflict'
3305 $ref: '#/components/responses/UnprocessableEntity'
3307 $ref: '#/components/responses/InternalServerError'
3309 $ref: '#/components/responses/ServiceUnavailable'
3311 $ref: '#/components/responses/UnexpectedError'
3313 $ref: '#/components/responses/UnexpectedError'
3314 # END NetSlice Instances
3317 '/nspm/v1/pm_jobs/{pmJobId}/reports/{nsId}':
3322 description: NS PM Job ID
3333 - "NS Performance Management"
3334 summary: Query information about an individual NS PM Job Report
3335 description: Query information about an individual NS PM Job Report
3336 operationId: getNsPmJobReport
3343 $ref: '#/components/schemas/NsPmJobReportInfo'
3346 $ref: '#/components/schemas/NsPmJobReportInfo'
3348 $ref: '#/components/responses/BadRequest'
3350 $ref: '#/components/responses/Unauthorized'
3352 $ref: '#/components/responses/Forbidden'
3354 $ref: '#/components/responses/NotFound'
3356 $ref: '#/components/responses/MethodNotAllowed'
3358 $ref: '#/components/responses/NotAcceptable'
3360 $ref: '#/components/responses/Conflict'
3362 $ref: '#/components/responses/UnprocessableEntity'
3364 $ref: '#/components/responses/InternalServerError'
3366 $ref: '#/components/responses/ServiceUnavailable'
3368 $ref: '#/components/responses/UnexpectedError'
3370 $ref: '#/components/responses/UnexpectedError'
3374 '/pdu/v1/pdu_descriptors':
3377 - "Physical Data Units (PDU)"
3378 summary: Query information about multiple PDU Descriptors
3379 description: Query information about multiple PDU Descriptors
3380 operationId: getPDUs
3387 $ref: '#/components/schemas/ArrayOfPduInfo'
3390 $ref: '#/components/schemas/ArrayOfPduInfo'
3392 $ref: '#/components/responses/BadRequest'
3394 $ref: '#/components/responses/Unauthorized'
3396 $ref: '#/components/responses/Forbidden'
3398 $ref: '#/components/responses/NotFound'
3400 $ref: '#/components/responses/MethodNotAllowed'
3402 $ref: '#/components/responses/NotAcceptable'
3404 $ref: '#/components/responses/Conflict'
3406 $ref: '#/components/responses/UnprocessableEntity'
3408 $ref: '#/components/responses/InternalServerError'
3410 $ref: '#/components/responses/ServiceUnavailable'
3412 $ref: '#/components/responses/UnexpectedError'
3414 $ref: '#/components/responses/UnexpectedError'
3417 - "Physical Data Units (PDU)"
3418 summary: Create a new PDU
3419 description: Create a new PDU Descriptor
3420 operationId: createPDU
3422 $ref: '#/components/requestBodies/CreatePduRequest'
3434 $ref: '#/components/schemas/ObjectId'
3437 $ref: '#/components/schemas/ObjectId'
3439 $ref: '#/components/responses/BadRequest'
3441 $ref: '#/components/responses/Unauthorized'
3443 $ref: '#/components/responses/Forbidden'
3445 $ref: '#/components/responses/NotFound'
3447 $ref: '#/components/responses/MethodNotAllowed'
3449 $ref: '#/components/responses/NotAcceptable'
3451 $ref: '#/components/responses/Conflict'
3453 $ref: '#/components/responses/UnprocessableEntity'
3455 $ref: '#/components/responses/InternalServerError'
3457 $ref: '#/components/responses/ServiceUnavailable'
3459 $ref: '#/components/responses/UnexpectedError'
3461 $ref: '#/components/responses/UnexpectedError'
3462 '/pdu/v1/pdu_descriptors/{pduDescriptorId}':
3464 - name: pduDescriptorId
3467 description: PDU Descriptor ID
3472 - "Physical Data Units (PDU)"
3473 summary: Query information about an individual PDU Descriptor
3474 description: Query information about an individual PDU Descriptor
3482 $ref: '#/components/schemas/PduInfo'
3485 $ref: '#/components/schemas/PduInfo'
3487 $ref: '#/components/responses/BadRequest'
3489 $ref: '#/components/responses/Unauthorized'
3491 $ref: '#/components/responses/Forbidden'
3493 $ref: '#/components/responses/NotFound'
3495 $ref: '#/components/responses/MethodNotAllowed'
3497 $ref: '#/components/responses/NotAcceptable'
3499 $ref: '#/components/responses/Conflict'
3501 $ref: '#/components/responses/UnprocessableEntity'
3503 $ref: '#/components/responses/InternalServerError'
3505 $ref: '#/components/responses/ServiceUnavailable'
3507 $ref: '#/components/responses/UnexpectedError'
3509 $ref: '#/components/responses/UnexpectedError'
3512 - "Physical Data Units (PDU)"
3513 summary: Modify an individual PDU Descriptor
3514 description: Modify an individual PDU Descriptor
3515 operationId: editPDU
3517 $ref: '#/components/requestBodies/EditPduRequest'
3520 description: No Content
3522 $ref: '#/components/responses/BadRequest'
3524 $ref: '#/components/responses/Unauthorized'
3526 $ref: '#/components/responses/Forbidden'
3528 $ref: '#/components/responses/NotFound'
3530 $ref: '#/components/responses/MethodNotAllowed'
3532 $ref: '#/components/responses/NotAcceptable'
3534 $ref: '#/components/responses/Conflict'
3536 $ref: '#/components/responses/UnprocessableEntity'
3538 $ref: '#/components/responses/InternalServerError'
3540 $ref: '#/components/responses/ServiceUnavailable'
3542 $ref: '#/components/responses/UnexpectedError'
3544 $ref: '#/components/responses/UnexpectedError'
3547 - "Physical Data Units (PDU)"
3548 summary: Delete an individual PDU Descriptor
3549 description: Delete an individual PDU Descriptor
3550 operationId: deletePDU
3553 description: No Content
3555 $ref: '#/components/responses/BadRequest'
3557 $ref: '#/components/responses/Unauthorized'
3559 $ref: '#/components/responses/Forbidden'
3561 $ref: '#/components/responses/NotFound'
3563 $ref: '#/components/responses/MethodNotAllowed'
3565 $ref: '#/components/responses/NotAcceptable'
3567 $ref: '#/components/responses/Conflict'
3569 $ref: '#/components/responses/UnprocessableEntity'
3571 $ref: '#/components/responses/InternalServerError'
3573 $ref: '#/components/responses/ServiceUnavailable'
3575 $ref: '#/components/responses/UnexpectedError'
3577 $ref: '#/components/responses/UnexpectedError'
3586 summary: Query information about multiple Tokens
3587 description: Query information about multiple Tokens
3588 operationId: getTokens
3595 $ref: '#/components/schemas/ArrayOfTokenInfo'
3598 $ref: '#/components/schemas/ArrayOfTokenInfo'
3600 $ref: '#/components/responses/BadRequest'
3602 $ref: '#/components/responses/Unauthorized'
3604 $ref: '#/components/responses/Forbidden'
3606 $ref: '#/components/responses/NotFound'
3608 $ref: '#/components/responses/MethodNotAllowed'
3610 $ref: '#/components/responses/NotAcceptable'
3612 $ref: '#/components/responses/Conflict'
3614 $ref: '#/components/responses/UnprocessableEntity'
3616 $ref: '#/components/responses/InternalServerError'
3618 $ref: '#/components/responses/ServiceUnavailable'
3620 $ref: '#/components/responses/UnexpectedError'
3622 $ref: '#/components/responses/UnexpectedError'
3627 summary: Request a new Token
3628 description: Request a new Token
3629 operationId: createToken
3631 $ref: '#/components/requestBodies/CreateTokenRequest'
3643 $ref: '#/components/schemas/TokenInfo'
3646 $ref: '#/components/schemas/TokenInfo'
3648 $ref: '#/components/responses/BadRequest'
3650 $ref: '#/components/responses/Unauthorized'
3652 $ref: '#/components/responses/Forbidden'
3654 $ref: '#/components/responses/NotFound'
3656 $ref: '#/components/responses/MethodNotAllowed'
3658 $ref: '#/components/responses/NotAcceptable'
3660 $ref: '#/components/responses/Conflict'
3662 $ref: '#/components/responses/UnprocessableEntity'
3664 $ref: '#/components/responses/InternalServerError'
3666 $ref: '#/components/responses/ServiceUnavailable'
3668 $ref: '#/components/responses/UnexpectedError'
3670 $ref: '#/components/responses/UnexpectedError'
3675 summary: Delete the Token indicated in the Authorization Header
3676 description: Delete the Token indicated in the Authorization Header
3677 operationId: deleteAuthToken
3689 $ref: '#/components/responses/BadRequest'
3691 $ref: '#/components/responses/Unauthorized'
3693 $ref: '#/components/responses/Forbidden'
3695 $ref: '#/components/responses/NotFound'
3697 $ref: '#/components/responses/MethodNotAllowed'
3699 $ref: '#/components/responses/NotAcceptable'
3701 $ref: '#/components/responses/Conflict'
3703 $ref: '#/components/responses/UnprocessableEntity'
3705 $ref: '#/components/responses/InternalServerError'
3707 $ref: '#/components/responses/ServiceUnavailable'
3709 $ref: '#/components/responses/UnexpectedError'
3711 $ref: '#/components/responses/UnexpectedError'
3712 '/admin/v1/tokens/{tokenId}':
3717 description: Token ID
3724 summary: Query information about an individual Token
3725 description: Query information about an individual Token
3726 operationId: getToken
3733 $ref: '#/components/schemas/TokenInfo'
3736 $ref: '#/components/schemas/TokenInfo'
3738 $ref: '#/components/responses/BadRequest'
3740 $ref: '#/components/responses/Unauthorized'
3742 $ref: '#/components/responses/Forbidden'
3744 $ref: '#/components/responses/NotFound'
3746 $ref: '#/components/responses/MethodNotAllowed'
3748 $ref: '#/components/responses/NotAcceptable'
3750 $ref: '#/components/responses/Conflict'
3752 $ref: '#/components/responses/UnprocessableEntity'
3754 $ref: '#/components/responses/InternalServerError'
3756 $ref: '#/components/responses/ServiceUnavailable'
3758 $ref: '#/components/responses/UnexpectedError'
3760 $ref: '#/components/responses/UnexpectedError'
3765 summary: Delete the Token indicated as parameter
3766 description: Delete the Token indicated as parameter
3767 operationId: deleteToken
3779 $ref: '#/components/responses/BadRequest'
3781 $ref: '#/components/responses/Unauthorized'
3783 $ref: '#/components/responses/Forbidden'
3785 $ref: '#/components/responses/NotFound'
3787 $ref: '#/components/responses/MethodNotAllowed'
3789 $ref: '#/components/responses/NotAcceptable'
3791 $ref: '#/components/responses/Conflict'
3793 $ref: '#/components/responses/UnprocessableEntity'
3795 $ref: '#/components/responses/InternalServerError'
3797 $ref: '#/components/responses/ServiceUnavailable'
3799 $ref: '#/components/responses/UnexpectedError'
3801 $ref: '#/components/responses/UnexpectedError'
3807 summary: Query information about multiple Users
3808 description: Query information about multiple Users
3809 operationId: getUsers
3816 $ref: '#/components/schemas/ArrayOfUserInfo'
3819 $ref: '#/components/schemas/ArrayOfUserInfo'
3821 $ref: '#/components/responses/BadRequest'
3823 $ref: '#/components/responses/Unauthorized'
3825 $ref: '#/components/responses/Forbidden'
3827 $ref: '#/components/responses/NotFound'
3829 $ref: '#/components/responses/MethodNotAllowed'
3831 $ref: '#/components/responses/NotAcceptable'
3833 $ref: '#/components/responses/Conflict'
3835 $ref: '#/components/responses/UnprocessableEntity'
3837 $ref: '#/components/responses/InternalServerError'
3839 $ref: '#/components/responses/ServiceUnavailable'
3841 $ref: '#/components/responses/UnexpectedError'
3843 $ref: '#/components/responses/UnexpectedError'
3848 summary: Create a new User
3849 description: Create a new User
3850 operationId: createUser
3852 $ref: '#/components/requestBodies/CreateUserRequest'
3855 description: Created
3864 $ref: '#/components/schemas/ObjectId'
3867 $ref: '#/components/schemas/ObjectId'
3869 $ref: '#/components/responses/BadRequest'
3871 $ref: '#/components/responses/Unauthorized'
3873 $ref: '#/components/responses/Forbidden'
3875 $ref: '#/components/responses/NotFound'
3877 $ref: '#/components/responses/MethodNotAllowed'
3879 $ref: '#/components/responses/NotAcceptable'
3881 $ref: '#/components/responses/Conflict'
3883 $ref: '#/components/responses/UnprocessableEntity'
3885 $ref: '#/components/responses/InternalServerError'
3887 $ref: '#/components/responses/ServiceUnavailable'
3889 $ref: '#/components/responses/UnexpectedError'
3891 $ref: '#/components/responses/UnexpectedError'
3892 '/admin/v1/users/{userId}':
3897 description: User ID/Name
3904 summary: Query information about an individual User
3905 description: Query information about an individual User
3906 operationId: getUser
3913 $ref: '#/components/schemas/UserInfo'
3916 $ref: '#/components/schemas/UserInfo'
3918 $ref: '#/components/responses/BadRequest'
3920 $ref: '#/components/responses/Unauthorized'
3922 $ref: '#/components/responses/Forbidden'
3924 $ref: '#/components/responses/NotFound'
3926 $ref: '#/components/responses/MethodNotAllowed'
3928 $ref: '#/components/responses/NotAcceptable'
3930 $ref: '#/components/responses/Conflict'
3932 $ref: '#/components/responses/UnprocessableEntity'
3934 $ref: '#/components/responses/InternalServerError'
3936 $ref: '#/components/responses/ServiceUnavailable'
3938 $ref: '#/components/responses/UnexpectedError'
3940 $ref: '#/components/responses/UnexpectedError'
3945 summary: Modify a User
3946 description: Modify a User
3947 operationId: editUser
3949 $ref: '#/components/requestBodies/EditUserRequest'
3952 description: No Content
3954 $ref: '#/components/responses/BadRequest'
3956 $ref: '#/components/responses/Unauthorized'
3958 $ref: '#/components/responses/Forbidden'
3960 $ref: '#/components/responses/NotFound'
3962 $ref: '#/components/responses/MethodNotAllowed'
3964 $ref: '#/components/responses/NotAcceptable'
3966 $ref: '#/components/responses/Conflict'
3968 $ref: '#/components/responses/UnprocessableEntity'
3970 $ref: '#/components/responses/InternalServerError'
3972 $ref: '#/components/responses/ServiceUnavailable'
3974 $ref: '#/components/responses/UnexpectedError'
3976 $ref: '#/components/responses/UnexpectedError'
3981 summary: Delete a User
3982 description: Delete a User
3983 operationId: deleteUser
3986 description: No Content
3988 $ref: '#/components/responses/BadRequest'
3990 $ref: '#/components/responses/Unauthorized'
3992 $ref: '#/components/responses/Forbidden'
3994 $ref: '#/components/responses/NotFound'
3996 $ref: '#/components/responses/MethodNotAllowed'
3998 $ref: '#/components/responses/NotAcceptable'
4000 $ref: '#/components/responses/Conflict'
4002 $ref: '#/components/responses/UnprocessableEntity'
4004 $ref: '#/components/responses/InternalServerError'
4006 $ref: '#/components/responses/ServiceUnavailable'
4008 $ref: '#/components/responses/UnexpectedError'
4010 $ref: '#/components/responses/UnexpectedError'
4011 '/admin/v1/projects':
4016 summary: Query information about multiple Projects
4017 description: Query information about multiple Projects
4018 operationId: getProjects
4025 $ref: '#/components/schemas/ArrayOfProjectInfo'
4028 $ref: '#/components/schemas/ArrayOfProjectInfo'
4030 $ref: '#/components/responses/BadRequest'
4032 $ref: '#/components/responses/Unauthorized'
4034 $ref: '#/components/responses/Forbidden'
4036 $ref: '#/components/responses/NotFound'
4038 $ref: '#/components/responses/MethodNotAllowed'
4040 $ref: '#/components/responses/NotAcceptable'
4042 $ref: '#/components/responses/Conflict'
4044 $ref: '#/components/responses/UnprocessableEntity'
4046 $ref: '#/components/responses/InternalServerError'
4048 $ref: '#/components/responses/ServiceUnavailable'
4050 $ref: '#/components/responses/UnexpectedError'
4052 $ref: '#/components/responses/UnexpectedError'
4057 summary: Create a new Project
4058 description: Create a new Project
4059 operationId: createProject
4061 $ref: '#/components/requestBodies/CreateProjectRequest'
4064 description: Created
4073 $ref: '#/components/schemas/ObjectId'
4076 $ref: '#/components/schemas/ObjectId'
4078 $ref: '#/components/responses/BadRequest'
4080 $ref: '#/components/responses/Unauthorized'
4082 $ref: '#/components/responses/Forbidden'
4084 $ref: '#/components/responses/NotFound'
4086 $ref: '#/components/responses/MethodNotAllowed'
4088 $ref: '#/components/responses/NotAcceptable'
4090 $ref: '#/components/responses/Conflict'
4092 $ref: '#/components/responses/UnprocessableEntity'
4094 $ref: '#/components/responses/InternalServerError'
4096 $ref: '#/components/responses/ServiceUnavailable'
4098 $ref: '#/components/responses/UnexpectedError'
4100 $ref: '#/components/responses/UnexpectedError'
4101 '/admin/v1/projects/{projectId}':
4106 description: Project ID/Name
4113 summary: Query information about an individual Project
4114 description: Query information about an individual Project
4115 operationId: getProject
4122 $ref: '#/components/schemas/ProjectInfo'
4125 $ref: '#/components/schemas/ProjectInfo'
4127 $ref: '#/components/responses/BadRequest'
4129 $ref: '#/components/responses/Unauthorized'
4131 $ref: '#/components/responses/Forbidden'
4133 $ref: '#/components/responses/NotFound'
4135 $ref: '#/components/responses/MethodNotAllowed'
4137 $ref: '#/components/responses/NotAcceptable'
4139 $ref: '#/components/responses/Conflict'
4141 $ref: '#/components/responses/UnprocessableEntity'
4143 $ref: '#/components/responses/InternalServerError'
4145 $ref: '#/components/responses/ServiceUnavailable'
4147 $ref: '#/components/responses/UnexpectedError'
4149 $ref: '#/components/responses/UnexpectedError'
4154 summary: Modify a Project
4155 description: Modify a Project
4156 operationId: editProject
4158 $ref: '#/components/requestBodies/EditProjectRequest'
4161 description: No Content
4163 $ref: '#/components/responses/BadRequest'
4165 $ref: '#/components/responses/Unauthorized'
4167 $ref: '#/components/responses/Forbidden'
4169 $ref: '#/components/responses/NotFound'
4171 $ref: '#/components/responses/MethodNotAllowed'
4173 $ref: '#/components/responses/NotAcceptable'
4175 $ref: '#/components/responses/Conflict'
4177 $ref: '#/components/responses/UnprocessableEntity'
4179 $ref: '#/components/responses/InternalServerError'
4181 $ref: '#/components/responses/ServiceUnavailable'
4183 $ref: '#/components/responses/UnexpectedError'
4185 $ref: '#/components/responses/UnexpectedError'
4190 summary: Delete a Project
4191 description: Delete a Project
4192 operationId: deleteProject
4195 description: No Content
4197 $ref: '#/components/responses/BadRequest'
4199 $ref: '#/components/responses/Unauthorized'
4201 $ref: '#/components/responses/Forbidden'
4203 $ref: '#/components/responses/NotFound'
4205 $ref: '#/components/responses/MethodNotAllowed'
4207 $ref: '#/components/responses/NotAcceptable'
4209 $ref: '#/components/responses/Conflict'
4211 $ref: '#/components/responses/UnprocessableEntity'
4213 $ref: '#/components/responses/InternalServerError'
4215 $ref: '#/components/responses/ServiceUnavailable'
4217 $ref: '#/components/responses/UnexpectedError'
4219 $ref: '#/components/responses/UnexpectedError'
4225 summary: Query information about multiple Roles
4226 description: Query information about multiple Roles
4227 operationId: getRoles
4234 $ref: '#/components/schemas/ArrayOfRoleInfo'
4237 $ref: '#/components/schemas/ArrayOfRoleInfo'
4239 $ref: '#/components/responses/BadRequest'
4241 $ref: '#/components/responses/Unauthorized'
4243 $ref: '#/components/responses/Forbidden'
4245 $ref: '#/components/responses/NotFound'
4247 $ref: '#/components/responses/MethodNotAllowed'
4249 $ref: '#/components/responses/NotAcceptable'
4251 $ref: '#/components/responses/Conflict'
4253 $ref: '#/components/responses/UnprocessableEntity'
4255 $ref: '#/components/responses/InternalServerError'
4257 $ref: '#/components/responses/ServiceUnavailable'
4259 $ref: '#/components/responses/UnexpectedError'
4261 $ref: '#/components/responses/UnexpectedError'
4266 summary: Create a new Role
4267 description: Create a new Role
4268 operationId: createRole
4270 $ref: '#/components/requestBodies/CreateRoleRequest'
4273 description: Created
4282 $ref: '#/components/schemas/ObjectId'
4285 $ref: '#/components/schemas/ObjectId'
4287 $ref: '#/components/responses/BadRequest'
4289 $ref: '#/components/responses/Unauthorized'
4291 $ref: '#/components/responses/Forbidden'
4293 $ref: '#/components/responses/NotFound'
4295 $ref: '#/components/responses/MethodNotAllowed'
4297 $ref: '#/components/responses/NotAcceptable'
4299 $ref: '#/components/responses/Conflict'
4301 $ref: '#/components/responses/UnprocessableEntity'
4303 $ref: '#/components/responses/InternalServerError'
4305 $ref: '#/components/responses/ServiceUnavailable'
4307 $ref: '#/components/responses/UnexpectedError'
4309 $ref: '#/components/responses/UnexpectedError'
4310 '/admin/v1/roles/{roleId}':
4315 description: Role ID/Name
4322 summary: Query information about an individual Role
4323 description: Query information about an individual Role
4324 operationId: getRole
4331 $ref: '#/components/schemas/RoleInfo'
4334 $ref: '#/components/schemas/RoleInfo'
4336 $ref: '#/components/responses/BadRequest'
4338 $ref: '#/components/responses/Unauthorized'
4340 $ref: '#/components/responses/Forbidden'
4342 $ref: '#/components/responses/NotFound'
4344 $ref: '#/components/responses/MethodNotAllowed'
4346 $ref: '#/components/responses/NotAcceptable'
4348 $ref: '#/components/responses/Conflict'
4350 $ref: '#/components/responses/UnprocessableEntity'
4352 $ref: '#/components/responses/InternalServerError'
4354 $ref: '#/components/responses/ServiceUnavailable'
4356 $ref: '#/components/responses/UnexpectedError'
4358 $ref: '#/components/responses/UnexpectedError'
4363 summary: Modify a Role
4364 description: Modify a Role
4365 operationId: editRole
4367 $ref: '#/components/requestBodies/EditRoleRequest'
4370 description: No Content
4372 $ref: '#/components/responses/BadRequest'
4374 $ref: '#/components/responses/Unauthorized'
4376 $ref: '#/components/responses/Forbidden'
4378 $ref: '#/components/responses/NotFound'
4380 $ref: '#/components/responses/MethodNotAllowed'
4382 $ref: '#/components/responses/NotAcceptable'
4384 $ref: '#/components/responses/Conflict'
4386 $ref: '#/components/responses/UnprocessableEntity'
4388 $ref: '#/components/responses/InternalServerError'
4390 $ref: '#/components/responses/ServiceUnavailable'
4392 $ref: '#/components/responses/UnexpectedError'
4394 $ref: '#/components/responses/UnexpectedError'
4399 summary: Delete a Role
4400 description: Delete a Role
4401 operationId: deleteRole
4404 description: No Content
4406 $ref: '#/components/responses/BadRequest'
4408 $ref: '#/components/responses/Unauthorized'
4410 $ref: '#/components/responses/Forbidden'
4412 $ref: '#/components/responses/NotFound'
4414 $ref: '#/components/responses/MethodNotAllowed'
4416 $ref: '#/components/responses/NotAcceptable'
4418 $ref: '#/components/responses/Conflict'
4420 $ref: '#/components/responses/UnprocessableEntity'
4422 $ref: '#/components/responses/InternalServerError'
4424 $ref: '#/components/responses/ServiceUnavailable'
4426 $ref: '#/components/responses/UnexpectedError'
4428 $ref: '#/components/responses/UnexpectedError'
4434 summary: Query information about multiple VIMs
4435 description: Query information about multiple VIMs
4436 operationId: getVIMs
4443 $ref: '#/components/schemas/ArrayOfVimInfo'
4446 $ref: '#/components/schemas/ArrayOfVimInfo'
4448 $ref: '#/components/responses/BadRequest'
4450 $ref: '#/components/responses/Unauthorized'
4452 $ref: '#/components/responses/Forbidden'
4454 $ref: '#/components/responses/NotFound'
4456 $ref: '#/components/responses/MethodNotAllowed'
4458 $ref: '#/components/responses/NotAcceptable'
4460 $ref: '#/components/responses/Conflict'
4462 $ref: '#/components/responses/UnprocessableEntity'
4464 $ref: '#/components/responses/InternalServerError'
4466 $ref: '#/components/responses/ServiceUnavailable'
4468 $ref: '#/components/responses/UnexpectedError'
4470 $ref: '#/components/responses/UnexpectedError'
4475 summary: Create a new VIM
4476 description: Create a new VIM
4477 operationId: createVIM
4479 $ref: '#/components/requestBodies/CreateVimRequest'
4482 description: Accepted
4486 $ref: '#/components/schemas/ObjectId_plus_OpId'
4489 $ref: '#/components/schemas/ObjectId_plus_OpId'
4491 $ref: '#/components/responses/BadRequest'
4493 $ref: '#/components/responses/Unauthorized'
4495 $ref: '#/components/responses/Forbidden'
4497 $ref: '#/components/responses/NotFound'
4499 $ref: '#/components/responses/MethodNotAllowed'
4501 $ref: '#/components/responses/NotAcceptable'
4503 $ref: '#/components/responses/Conflict'
4505 $ref: '#/components/responses/UnprocessableEntity'
4507 $ref: '#/components/responses/InternalServerError'
4509 $ref: '#/components/responses/ServiceUnavailable'
4511 $ref: '#/components/responses/UnexpectedError'
4513 $ref: '#/components/responses/UnexpectedError'
4514 '/admin/v1/vims/{vimId}':
4527 summary: Query information about an individual VIM
4528 description: Query information about an individual VIM
4536 $ref: '#/components/schemas/VimInfo'
4539 $ref: '#/components/schemas/VimInfo'
4541 $ref: '#/components/responses/BadRequest'
4543 $ref: '#/components/responses/Unauthorized'
4545 $ref: '#/components/responses/Forbidden'
4547 $ref: '#/components/responses/NotFound'
4549 $ref: '#/components/responses/MethodNotAllowed'
4551 $ref: '#/components/responses/NotAcceptable'
4553 $ref: '#/components/responses/Conflict'
4555 $ref: '#/components/responses/UnprocessableEntity'
4557 $ref: '#/components/responses/InternalServerError'
4559 $ref: '#/components/responses/ServiceUnavailable'
4561 $ref: '#/components/responses/UnexpectedError'
4563 $ref: '#/components/responses/UnexpectedError'
4568 summary: Modify a VIM
4569 description: Modify a VIM
4570 operationId: editVIM
4572 $ref: '#/components/requestBodies/EditVimRequest'
4575 description: Accepted
4579 $ref: '#/components/schemas/OpId'
4582 $ref: '#/components/schemas/OpId'
4584 $ref: '#/components/responses/BadRequest'
4586 $ref: '#/components/responses/Unauthorized'
4588 $ref: '#/components/responses/Forbidden'
4590 $ref: '#/components/responses/NotFound'
4592 $ref: '#/components/responses/MethodNotAllowed'
4594 $ref: '#/components/responses/NotAcceptable'
4596 $ref: '#/components/responses/Conflict'
4598 $ref: '#/components/responses/UnprocessableEntity'
4600 $ref: '#/components/responses/InternalServerError'
4602 $ref: '#/components/responses/ServiceUnavailable'
4604 $ref: '#/components/responses/UnexpectedError'
4606 $ref: '#/components/responses/UnexpectedError'
4611 summary: Delete a VIM
4612 description: Delete a VIM
4613 operationId: deleteVIM
4616 description: Accepted
4618 $ref: '#/components/responses/BadRequest'
4620 $ref: '#/components/responses/Unauthorized'
4622 $ref: '#/components/responses/Forbidden'
4624 $ref: '#/components/responses/NotFound'
4626 $ref: '#/components/responses/MethodNotAllowed'
4628 $ref: '#/components/responses/NotAcceptable'
4630 $ref: '#/components/responses/Conflict'
4632 $ref: '#/components/responses/UnprocessableEntity'
4634 $ref: '#/components/responses/InternalServerError'
4636 $ref: '#/components/responses/ServiceUnavailable'
4638 $ref: '#/components/responses/UnexpectedError'
4640 $ref: '#/components/responses/UnexpectedError'
4641 '/admin/v1/vim_accounts':
4646 summary: Query information about multiple VIM Accounts
4647 description: Query information about multiple VIM Accounts
4648 operationId: getVimAccounts
4655 $ref: '#/components/schemas/ArrayOfVimInfo'
4658 $ref: '#/components/schemas/ArrayOfVimInfo'
4660 $ref: '#/components/responses/BadRequest'
4662 $ref: '#/components/responses/Unauthorized'
4664 $ref: '#/components/responses/Forbidden'
4666 $ref: '#/components/responses/NotFound'
4668 $ref: '#/components/responses/MethodNotAllowed'
4670 $ref: '#/components/responses/NotAcceptable'
4672 $ref: '#/components/responses/Conflict'
4674 $ref: '#/components/responses/UnprocessableEntity'
4676 $ref: '#/components/responses/InternalServerError'
4678 $ref: '#/components/responses/ServiceUnavailable'
4680 $ref: '#/components/responses/UnexpectedError'
4682 $ref: '#/components/responses/UnexpectedError'
4687 summary: Create a new VIM Account
4688 description: Create a new VIM Account
4689 operationId: createVimAccount
4691 $ref: '#/components/requestBodies/CreateVimRequest'
4694 description: Accepted
4698 $ref: '#/components/schemas/ObjectId_plus_OpId'
4701 $ref: '#/components/schemas/ObjectId_plus_OpId'
4703 $ref: '#/components/responses/BadRequest'
4705 $ref: '#/components/responses/Unauthorized'
4707 $ref: '#/components/responses/Forbidden'
4709 $ref: '#/components/responses/NotFound'
4711 $ref: '#/components/responses/MethodNotAllowed'
4713 $ref: '#/components/responses/NotAcceptable'
4715 $ref: '#/components/responses/Conflict'
4717 $ref: '#/components/responses/UnprocessableEntity'
4719 $ref: '#/components/responses/InternalServerError'
4721 $ref: '#/components/responses/ServiceUnavailable'
4723 $ref: '#/components/responses/UnexpectedError'
4725 $ref: '#/components/responses/UnexpectedError'
4726 '/admin/v1/vim_accounts/{vimAccountId}':
4728 - name: vimAccountId
4731 description: VIM Account ID
4739 summary: Query information about an individual VIM Account
4740 description: Query information about an individual VIM Account
4741 operationId: getVimAccount
4748 $ref: '#/components/schemas/VimInfo'
4751 $ref: '#/components/schemas/VimInfo'
4753 $ref: '#/components/responses/BadRequest'
4755 $ref: '#/components/responses/Unauthorized'
4757 $ref: '#/components/responses/Forbidden'
4759 $ref: '#/components/responses/NotFound'
4761 $ref: '#/components/responses/MethodNotAllowed'
4763 $ref: '#/components/responses/NotAcceptable'
4765 $ref: '#/components/responses/Conflict'
4767 $ref: '#/components/responses/UnprocessableEntity'
4769 $ref: '#/components/responses/InternalServerError'
4771 $ref: '#/components/responses/ServiceUnavailable'
4773 $ref: '#/components/responses/UnexpectedError'
4775 $ref: '#/components/responses/UnexpectedError'
4780 summary: Modify a VIM Account
4781 description: Modify a VIM Account
4782 operationId: editVimAccount
4784 $ref: '#/components/requestBodies/EditVimRequest'
4787 description: Accepted
4791 $ref: '#/components/schemas/OpId'
4794 $ref: '#/components/schemas/OpId'
4796 $ref: '#/components/responses/BadRequest'
4798 $ref: '#/components/responses/Unauthorized'
4800 $ref: '#/components/responses/Forbidden'
4802 $ref: '#/components/responses/NotFound'
4804 $ref: '#/components/responses/MethodNotAllowed'
4806 $ref: '#/components/responses/NotAcceptable'
4808 $ref: '#/components/responses/Conflict'
4810 $ref: '#/components/responses/UnprocessableEntity'
4812 $ref: '#/components/responses/InternalServerError'
4814 $ref: '#/components/responses/ServiceUnavailable'
4816 $ref: '#/components/responses/UnexpectedError'
4818 $ref: '#/components/responses/UnexpectedError'
4823 summary: Delete a VIM Account
4824 description: Delete a VIM Account
4825 operationId: deleteVimAccount
4828 description: Accepted
4830 $ref: '#/components/responses/BadRequest'
4832 $ref: '#/components/responses/Unauthorized'
4834 $ref: '#/components/responses/Forbidden'
4836 $ref: '#/components/responses/NotFound'
4838 $ref: '#/components/responses/MethodNotAllowed'
4840 $ref: '#/components/responses/NotAcceptable'
4842 $ref: '#/components/responses/Conflict'
4844 $ref: '#/components/responses/UnprocessableEntity'
4846 $ref: '#/components/responses/InternalServerError'
4848 $ref: '#/components/responses/ServiceUnavailable'
4850 $ref: '#/components/responses/UnexpectedError'
4852 $ref: '#/components/responses/UnexpectedError'
4853 '/admin/v1/wim_accounts':
4858 summary: Query information about multiple WIM Accounts
4859 description: Query information about multiple WIM Accounts
4860 operationId: getWimAccounts
4867 $ref: '#/components/schemas/ArrayOfWimInfo'
4870 $ref: '#/components/schemas/ArrayOfWimInfo'
4872 $ref: '#/components/responses/BadRequest'
4874 $ref: '#/components/responses/Unauthorized'
4876 $ref: '#/components/responses/Forbidden'
4878 $ref: '#/components/responses/NotFound'
4880 $ref: '#/components/responses/MethodNotAllowed'
4882 $ref: '#/components/responses/NotAcceptable'
4884 $ref: '#/components/responses/Conflict'
4886 $ref: '#/components/responses/UnprocessableEntity'
4888 $ref: '#/components/responses/InternalServerError'
4890 $ref: '#/components/responses/ServiceUnavailable'
4892 $ref: '#/components/responses/UnexpectedError'
4894 $ref: '#/components/responses/UnexpectedError'
4899 summary: Create a new WIM Account
4900 description: Create a new WIM Account
4901 operationId: createWimAccount
4903 $ref: '#/components/requestBodies/CreateWimRequest'
4906 description: Accepted
4910 $ref: '#/components/schemas/ObjectId_plus_OpId'
4913 $ref: '#/components/schemas/ObjectId_plus_OpId'
4915 $ref: '#/components/responses/BadRequest'
4917 $ref: '#/components/responses/Unauthorized'
4919 $ref: '#/components/responses/Forbidden'
4921 $ref: '#/components/responses/NotFound'
4923 $ref: '#/components/responses/MethodNotAllowed'
4925 $ref: '#/components/responses/NotAcceptable'
4927 $ref: '#/components/responses/Conflict'
4929 $ref: '#/components/responses/UnprocessableEntity'
4931 $ref: '#/components/responses/InternalServerError'
4933 $ref: '#/components/responses/ServiceUnavailable'
4935 $ref: '#/components/responses/UnexpectedError'
4937 $ref: '#/components/responses/UnexpectedError'
4938 '/admin/v1/wim_accounts/{wimAccountId}':
4940 - name: wimAccountId
4943 description: WIM Account ID
4951 summary: Query information about an individual WIM Account
4952 description: Query information about an individual WIM Account
4953 operationId: getWimAccount
4960 $ref: '#/components/schemas/WimInfo'
4963 $ref: '#/components/schemas/WimInfo'
4965 $ref: '#/components/responses/BadRequest'
4967 $ref: '#/components/responses/Unauthorized'
4969 $ref: '#/components/responses/Forbidden'
4971 $ref: '#/components/responses/NotFound'
4973 $ref: '#/components/responses/MethodNotAllowed'
4975 $ref: '#/components/responses/NotAcceptable'
4977 $ref: '#/components/responses/Conflict'
4979 $ref: '#/components/responses/UnprocessableEntity'
4981 $ref: '#/components/responses/InternalServerError'
4983 $ref: '#/components/responses/ServiceUnavailable'
4985 $ref: '#/components/responses/UnexpectedError'
4987 $ref: '#/components/responses/UnexpectedError'
4992 summary: Modify a WIM Account
4993 description: Modify a WIM Account
4994 operationId: editWimAccount
4996 $ref: '#/components/requestBodies/EditWimRequest'
4999 description: Accepted
5003 $ref: '#/components/schemas/OpId'
5006 $ref: '#/components/schemas/OpId'
5008 $ref: '#/components/responses/BadRequest'
5010 $ref: '#/components/responses/Unauthorized'
5012 $ref: '#/components/responses/Forbidden'
5014 $ref: '#/components/responses/NotFound'
5016 $ref: '#/components/responses/MethodNotAllowed'
5018 $ref: '#/components/responses/NotAcceptable'
5020 $ref: '#/components/responses/Conflict'
5022 $ref: '#/components/responses/UnprocessableEntity'
5024 $ref: '#/components/responses/InternalServerError'
5026 $ref: '#/components/responses/ServiceUnavailable'
5028 $ref: '#/components/responses/UnexpectedError'
5030 $ref: '#/components/responses/UnexpectedError'
5035 summary: Delete a WIM Account
5036 description: Delete a WIM Account
5037 operationId: deleteWimAccount
5040 description: Accepted
5042 $ref: '#/components/responses/BadRequest'
5044 $ref: '#/components/responses/Unauthorized'
5046 $ref: '#/components/responses/Forbidden'
5048 $ref: '#/components/responses/NotFound'
5050 $ref: '#/components/responses/MethodNotAllowed'
5052 $ref: '#/components/responses/NotAcceptable'
5054 $ref: '#/components/responses/Conflict'
5056 $ref: '#/components/responses/UnprocessableEntity'
5058 $ref: '#/components/responses/InternalServerError'
5060 $ref: '#/components/responses/ServiceUnavailable'
5062 $ref: '#/components/responses/UnexpectedError'
5064 $ref: '#/components/responses/UnexpectedError'
5070 summary: Query information about multiple SDNs
5071 description: Query information about multiple SDNs
5072 operationId: getSDNs
5079 $ref: '#/components/schemas/ArrayOfSdnInfo'
5082 $ref: '#/components/schemas/ArrayOfSdnInfo'
5084 $ref: '#/components/responses/BadRequest'
5086 $ref: '#/components/responses/Unauthorized'
5088 $ref: '#/components/responses/Forbidden'
5090 $ref: '#/components/responses/NotFound'
5092 $ref: '#/components/responses/MethodNotAllowed'
5094 $ref: '#/components/responses/NotAcceptable'
5096 $ref: '#/components/responses/Conflict'
5098 $ref: '#/components/responses/UnprocessableEntity'
5100 $ref: '#/components/responses/InternalServerError'
5102 $ref: '#/components/responses/ServiceUnavailable'
5104 $ref: '#/components/responses/UnexpectedError'
5106 $ref: '#/components/responses/UnexpectedError'
5111 summary: Create a new SDN
5112 description: Create a new SDN
5113 operationId: createSDN
5115 $ref: '#/components/requestBodies/CreateSdnRequest'
5118 description: Accepted
5122 $ref: '#/components/schemas/ObjectId_plus_OpId'
5125 $ref: '#/components/schemas/ObjectId_plus_OpId'
5127 $ref: '#/components/responses/BadRequest'
5129 $ref: '#/components/responses/Unauthorized'
5131 $ref: '#/components/responses/Forbidden'
5133 $ref: '#/components/responses/NotFound'
5135 $ref: '#/components/responses/MethodNotAllowed'
5137 $ref: '#/components/responses/NotAcceptable'
5139 $ref: '#/components/responses/Conflict'
5141 $ref: '#/components/responses/UnprocessableEntity'
5143 $ref: '#/components/responses/InternalServerError'
5145 $ref: '#/components/responses/ServiceUnavailable'
5147 $ref: '#/components/responses/UnexpectedError'
5149 $ref: '#/components/responses/UnexpectedError'
5150 '/admin/v1/sdns/{sdnId}':
5163 summary: Query information about an individual SDN
5164 description: Query information about an individual SDN
5172 $ref: '#/components/schemas/SdnInfo'
5175 $ref: '#/components/schemas/SdnInfo'
5177 $ref: '#/components/responses/BadRequest'
5179 $ref: '#/components/responses/Unauthorized'
5181 $ref: '#/components/responses/Forbidden'
5183 $ref: '#/components/responses/NotFound'
5185 $ref: '#/components/responses/MethodNotAllowed'
5187 $ref: '#/components/responses/NotAcceptable'
5189 $ref: '#/components/responses/Conflict'
5191 $ref: '#/components/responses/UnprocessableEntity'
5193 $ref: '#/components/responses/InternalServerError'
5195 $ref: '#/components/responses/ServiceUnavailable'
5197 $ref: '#/components/responses/UnexpectedError'
5199 $ref: '#/components/responses/UnexpectedError'
5204 summary: Modify a SDN
5205 description: Modify a SDN
5206 operationId: editSDN
5208 $ref: '#/components/requestBodies/EditSdnRequest'
5211 description: Accepted
5215 $ref: '#/components/schemas/OpId'
5218 $ref: '#/components/schemas/OpId'
5220 $ref: '#/components/responses/BadRequest'
5222 $ref: '#/components/responses/Unauthorized'
5224 $ref: '#/components/responses/Forbidden'
5226 $ref: '#/components/responses/NotFound'
5228 $ref: '#/components/responses/MethodNotAllowed'
5230 $ref: '#/components/responses/NotAcceptable'
5232 $ref: '#/components/responses/Conflict'
5234 $ref: '#/components/responses/UnprocessableEntity'
5236 $ref: '#/components/responses/InternalServerError'
5238 $ref: '#/components/responses/ServiceUnavailable'
5240 $ref: '#/components/responses/UnexpectedError'
5242 $ref: '#/components/responses/UnexpectedError'
5247 summary: Delete a SDN
5248 description: Delete a SDN
5249 operationId: deleteSDN
5252 description: Accepted
5254 $ref: '#/components/responses/BadRequest'
5256 $ref: '#/components/responses/Unauthorized'
5258 $ref: '#/components/responses/Forbidden'
5260 $ref: '#/components/responses/NotFound'
5262 $ref: '#/components/responses/MethodNotAllowed'
5264 $ref: '#/components/responses/NotAcceptable'
5266 $ref: '#/components/responses/Conflict'
5268 $ref: '#/components/responses/UnprocessableEntity'
5270 $ref: '#/components/responses/InternalServerError'
5272 $ref: '#/components/responses/ServiceUnavailable'
5274 $ref: '#/components/responses/UnexpectedError'
5276 $ref: '#/components/responses/UnexpectedError'
5277 '/admin/v1/k8sclusters':
5282 summary: Query information about multiple K8s Clusters
5283 description: Query information about multiple K8s Clusters
5284 operationId: getK8sClusters
5291 $ref: '#/components/schemas/ArrayOfK8sClusterInfo'
5294 $ref: '#/components/schemas/ArrayOfK8sClusterInfo'
5296 $ref: '#/components/responses/BadRequest'
5298 $ref: '#/components/responses/Unauthorized'
5300 $ref: '#/components/responses/Forbidden'
5302 $ref: '#/components/responses/NotFound'
5304 $ref: '#/components/responses/MethodNotAllowed'
5306 $ref: '#/components/responses/NotAcceptable'
5308 $ref: '#/components/responses/Conflict'
5310 $ref: '#/components/responses/UnprocessableEntity'
5312 $ref: '#/components/responses/InternalServerError'
5314 $ref: '#/components/responses/ServiceUnavailable'
5316 $ref: '#/components/responses/UnexpectedError'
5318 $ref: '#/components/responses/UnexpectedError'
5323 summary: Create a new K8s Cluster
5324 description: Create a new K8s Cluster
5325 operationId: createK8sCluster
5327 $ref: '#/components/requestBodies/CreateK8sClusterRequest'
5330 description: Accepted
5334 $ref: '#/components/schemas/ObjectId_plus_OpId'
5337 $ref: '#/components/schemas/ObjectId_plus_OpId'
5339 $ref: '#/components/responses/BadRequest'
5341 $ref: '#/components/responses/Unauthorized'
5343 $ref: '#/components/responses/Forbidden'
5345 $ref: '#/components/responses/NotFound'
5347 $ref: '#/components/responses/MethodNotAllowed'
5349 $ref: '#/components/responses/NotAcceptable'
5351 $ref: '#/components/responses/Conflict'
5353 $ref: '#/components/responses/UnprocessableEntity'
5355 $ref: '#/components/responses/InternalServerError'
5357 $ref: '#/components/responses/ServiceUnavailable'
5359 $ref: '#/components/responses/UnexpectedError'
5361 $ref: '#/components/responses/UnexpectedError'
5362 '/admin/v1/k8sclusters/{k8sClusterId}':
5364 - name: k8sClusterId
5367 description: K8s Cluster ID
5375 summary: Query information about an individual K8s Cluster
5376 description: Query information about an individual K8s Cluster
5377 operationId: getK8sCluster
5384 $ref: '#/components/schemas/K8sClusterInfo'
5387 $ref: '#/components/schemas/K8sClusterInfo'
5389 $ref: '#/components/responses/BadRequest'
5391 $ref: '#/components/responses/Unauthorized'
5393 $ref: '#/components/responses/Forbidden'
5395 $ref: '#/components/responses/NotFound'
5397 $ref: '#/components/responses/MethodNotAllowed'
5399 $ref: '#/components/responses/NotAcceptable'
5401 $ref: '#/components/responses/Conflict'
5403 $ref: '#/components/responses/UnprocessableEntity'
5405 $ref: '#/components/responses/InternalServerError'
5407 $ref: '#/components/responses/ServiceUnavailable'
5409 $ref: '#/components/responses/UnexpectedError'
5411 $ref: '#/components/responses/UnexpectedError'
5416 summary: Modify a K8s Cluster
5417 description: Modify a K8s Cluster
5418 operationId: editK8sCluster
5420 $ref: '#/components/requestBodies/EditK8sClusterRequest'
5423 description: Accepted
5427 $ref: '#/components/schemas/OpId'
5430 $ref: '#/components/schemas/OpId'
5432 $ref: '#/components/responses/BadRequest'
5434 $ref: '#/components/responses/Unauthorized'
5436 $ref: '#/components/responses/Forbidden'
5438 $ref: '#/components/responses/NotFound'
5440 $ref: '#/components/responses/MethodNotAllowed'
5442 $ref: '#/components/responses/NotAcceptable'
5444 $ref: '#/components/responses/Conflict'
5446 $ref: '#/components/responses/UnprocessableEntity'
5448 $ref: '#/components/responses/InternalServerError'
5450 $ref: '#/components/responses/ServiceUnavailable'
5452 $ref: '#/components/responses/UnexpectedError'
5454 $ref: '#/components/responses/UnexpectedError'
5459 summary: Delete a K8s Cluster
5460 description: Delete a K8s Cluster
5461 operationId: deleteK8sCluster
5464 description: Accepted
5466 $ref: '#/components/responses/BadRequest'
5468 $ref: '#/components/responses/Unauthorized'
5470 $ref: '#/components/responses/Forbidden'
5472 $ref: '#/components/responses/NotFound'
5474 $ref: '#/components/responses/MethodNotAllowed'
5476 $ref: '#/components/responses/NotAcceptable'
5478 $ref: '#/components/responses/Conflict'
5480 $ref: '#/components/responses/UnprocessableEntity'
5482 $ref: '#/components/responses/InternalServerError'
5484 $ref: '#/components/responses/ServiceUnavailable'
5486 $ref: '#/components/responses/UnexpectedError'
5488 $ref: '#/components/responses/UnexpectedError'
5489 '/admin/v1/k8srepos':
5494 summary: Query information about multiple K8s Repos
5495 description: Query information about multiple K8s Repos
5496 operationId: getK8sRepos
5503 $ref: '#/components/schemas/ArrayOfK8sRepoInfo'
5506 $ref: '#/components/schemas/ArrayOfK8sRepoInfo'
5508 $ref: '#/components/responses/BadRequest'
5510 $ref: '#/components/responses/Unauthorized'
5512 $ref: '#/components/responses/Forbidden'
5514 $ref: '#/components/responses/NotFound'
5516 $ref: '#/components/responses/MethodNotAllowed'
5518 $ref: '#/components/responses/NotAcceptable'
5520 $ref: '#/components/responses/Conflict'
5522 $ref: '#/components/responses/UnprocessableEntity'
5524 $ref: '#/components/responses/InternalServerError'
5526 $ref: '#/components/responses/ServiceUnavailable'
5528 $ref: '#/components/responses/UnexpectedError'
5530 $ref: '#/components/responses/UnexpectedError'
5535 summary: Create a new K8s Repo
5536 description: Create a new K8s Repo
5537 operationId: createK8sRepo
5539 $ref: '#/components/requestBodies/CreateK8sRepoRequest'
5542 description: Accepted
5546 $ref: '#/components/schemas/ObjectId_plus_OpId'
5549 $ref: '#/components/schemas/ObjectId_plus_OpId'
5551 $ref: '#/components/responses/BadRequest'
5553 $ref: '#/components/responses/Unauthorized'
5555 $ref: '#/components/responses/Forbidden'
5557 $ref: '#/components/responses/NotFound'
5559 $ref: '#/components/responses/MethodNotAllowed'
5561 $ref: '#/components/responses/NotAcceptable'
5563 $ref: '#/components/responses/Conflict'
5565 $ref: '#/components/responses/UnprocessableEntity'
5567 $ref: '#/components/responses/InternalServerError'
5569 $ref: '#/components/responses/ServiceUnavailable'
5571 $ref: '#/components/responses/UnexpectedError'
5573 $ref: '#/components/responses/UnexpectedError'
5574 '/admin/v1/k8srepos/{k8sRepoId}':
5579 description: K8s Repo ID
5587 summary: Query information about an individual K8s Repo
5588 description: Query information about an individual K8s Repo
5589 operationId: getK8sRepo
5596 $ref: '#/components/schemas/K8sRepoInfo'
5599 $ref: '#/components/schemas/K8sRepoInfo'
5601 $ref: '#/components/responses/BadRequest'
5603 $ref: '#/components/responses/Unauthorized'
5605 $ref: '#/components/responses/Forbidden'
5607 $ref: '#/components/responses/NotFound'
5609 $ref: '#/components/responses/MethodNotAllowed'
5611 $ref: '#/components/responses/NotAcceptable'
5613 $ref: '#/components/responses/Conflict'
5615 $ref: '#/components/responses/UnprocessableEntity'
5617 $ref: '#/components/responses/InternalServerError'
5619 $ref: '#/components/responses/ServiceUnavailable'
5621 $ref: '#/components/responses/UnexpectedError'
5623 $ref: '#/components/responses/UnexpectedError'
5628 summary: Delete a K8s Repo
5629 description: Delete a K8s Repo
5630 operationId: deleteK8sRepo
5633 description: Accepted
5635 $ref: '#/components/responses/BadRequest'
5637 $ref: '#/components/responses/Unauthorized'
5639 $ref: '#/components/responses/Forbidden'
5641 $ref: '#/components/responses/NotFound'
5643 $ref: '#/components/responses/MethodNotAllowed'
5645 $ref: '#/components/responses/NotAcceptable'
5647 $ref: '#/components/responses/Conflict'
5649 $ref: '#/components/responses/UnprocessableEntity'
5651 $ref: '#/components/responses/InternalServerError'
5653 $ref: '#/components/responses/ServiceUnavailable'
5655 $ref: '#/components/responses/UnexpectedError'
5657 $ref: '#/components/responses/UnexpectedError'
5661 description: Find out more about OSM
5662 url: 'https://osm.etsi.org/docs/user-guide/'
5667 description: Bad request. The server cannot process the request due to a client error.
5671 $ref: '#/components/schemas/ProblemDetails'
5673 description: Authorization information is missing or invalid.
5677 $ref: '#/components/schemas/ProblemDetails'
5679 description: Not enough permissions to do this operation.
5683 $ref: '#/components/schemas/ProblemDetails'
5685 description: The specified resource was not found.
5689 $ref: '#/components/schemas/ProblemDetails'
5691 description: This method is not supported for the requested resource.
5695 $ref: '#/components/schemas/ProblemDetails'
5697 description: The requested resource content cannot match the Accept headers sent in the request.
5701 $ref: '#/components/schemas/ProblemDetails'
5703 description: The operation cannot be executed currently, due to a conflict with the state of the resource.
5707 $ref: '#/components/schemas/ProblemDetails'
5708 UnprocessableEntity:
5709 description: The request was well-formed but was unable to be followed due to semantic errors.
5713 $ref: '#/components/schemas/ProblemDetails'
5714 InternalServerError:
5715 description: Internal server error.
5719 $ref: '#/components/schemas/ProblemDetails'
5721 description: Service temporarily unavailable.
5725 $ref: '#/components/schemas/ProblemDetails'
5727 description: Unexpected error.
5731 $ref: '#/components/schemas/ProblemDetails'
5733 description: VNF Descriptor (plaintext)
5737 $ref: '#/components/schemas/VnfDescriptor'
5739 description: VNF Package (compressed)
5743 $ref: '#/components/schemas/VnfPackage'
5745 description: NS Descriptor (plaintext)
5749 $ref: '#/components/schemas/NsDescriptor'
5751 description: NS Package (compressed)
5755 $ref: '#/components/schemas/NsPackage'
5757 description: NetSlice Template (plaintext)
5761 $ref: '#/components/schemas/NetSliceTemplate'
5763 description: NetSlice Package (compressed)
5767 $ref: '#/components/schemas/NetSlicePackage'
5778 # A free list of key:value pairs
5780 additionalProperties: true
5787 CreateNsdInfoRequest:
5788 # A free list of key:value pairs
5790 additionalProperties: true
5791 NsdInfoModifications:
5793 NS Descriptor Information
5794 Only generic fields (id, name, description) are described
5795 For a full specification of the NS Descriptor see:
5796 http://osm-download.etsi.org/ftp/osm-doc/nsd.html
5800 description: NSD Identifier
5803 description: NSD Name
5806 description: NSD Description
5810 NS Descriptor Information
5811 Only generic fields (_id, id, name, description) are described
5812 For a full specification of the NS Descriptor see:
5813 http://osm-download.etsi.org/ftp/osm-doc/nsd.html
5818 Identifier of the onboarded individual NS descriptor
5819 resource. This identifier is allocated by the NFVO.
5824 This identifier, which is allocated by the NSD
5825 designer, identifies the NSD in a globally unique
5826 way. It is copied from the NSD content and shall be
5827 present after the NSD content is on-boarded.
5831 Name of the onboarded NSD. This information is
5832 copied from the NSD content and shall be present
5833 after the NSD content is on-boarded.
5837 Description of the onboarded NSD.
5838 This information is copied from the NSD content.
5846 $ref: '#/components/schemas/NsdInfo'
5862 additionalProperties: true
5872 CreateVnfPkgInfoRequest:
5873 # A free list of key:value pairs
5875 additionalProperties: true
5876 VnfPkgInfoModifications:
5878 VNF Package Information
5879 Only generic fields (id, name, description) are described
5880 For a full specification of the VNF Descriptor see:
5881 http://osm-download.etsi.org/ftp/osm-doc/vnfd.html
5885 description: VNF Package Identifier
5888 description: VNF Package Name
5891 description: VNF Package description
5895 VNF Package Information
5896 Only generic fields (_id, id, name, description) are described
5897 For a full specification of the VNF Descriptor see:
5898 http://osm-download.etsi.org/ftp/osm-doc/vnfd.html
5903 Identifier of the VNF package. This identifier is allocated by the NFVO.
5907 description: VNF Package Identifier
5910 description: VNF Package Name
5913 description: VNF Package description
5921 $ref: '#/components/schemas/VnfPkgInfo'
5923 # Substituted by InstantiateNsRequest
5926 NS Instance Information
5927 Only generic fields (_id, id, name, description) are described
5928 For a full specification of the NS Instance see:
5929 http://osm-download.etsi.org/ftp/osm-doc/nsr.html
5933 description: Identifier of the NS instance.
5937 description: Identifier of the NS instance.
5941 description: Human readable name of the NS instance.
5944 description: Human readable description of the NS instance.
5950 InstantiateNsRequest:
5955 Human-readable name of the NS instance to be created.
5959 Identifier of the NSD that defines the NS instance to be created.
5964 Identifier of the VIM Account where the NS instance shall be created.
5983 additionalParamsForNs:
5985 additionalProperties: true
5986 additionalParamsForVnf:
5995 additionalProperties: true
5996 additionalParamsForVdu:
6005 additionalProperties: true
6009 additionalProperties: false
6010 additionalParamsForKdu:
6019 additionalProperties: true
6023 additionalProperties: false
6027 additionalProperties: false
6066 additionalProperties: false
6081 floating-ip-required:
6085 additionalProperties: false
6089 additionalProperties: false
6128 additionalProperties: false
6142 additionalProperties: false
6144 additionalProperties: false
6152 additionalProperties: false
6153 internal-connection-point:
6166 additionalProperties: False
6171 additionalProperties: false
6176 additionalProperties: false
6195 additionalProperties: true
6203 additionalProperties: true
6211 additionalProperties: false
6212 vnfd-connection-point-ref:
6217 member-vnf-index-ref:
6219 vnfd-connection-point-ref:
6225 - member-vnf-index-ref
6226 - vnfd-connection-point-ref
6228 additionalProperties: false
6232 additionalProperties: false
6238 additionalProperties: false
6257 scaling-group-descriptor:
6261 additionalProperties: true
6262 additionalProperties: true
6263 additionalProperties: true
6269 Timestamp indicating the end time of the NS, i.e. the NS will be terminated
6270 automatically at this timestamp. Cardinality "0" indicates the NS termination
6271 takes place immediately.
6277 $ref: '#/components/schemas/NsInstance'
6278 NSinstanceActionRequest:
6284 $ref: '#/components/schemas/KeyValuePairs'
6299 additionalProperties: false
6300 # CreateNSinstanceContentRequest:
6301 # Substituted by InstantiateNsRequest
6302 CreateNSinstanceContentResponse:
6325 isAutomaticInvocation:
6367 $ref: '#/components/schemas/NsLcmOpOcc'
6370 VNF Instance Information
6371 Only generic fields (_id, id) are described
6372 For a full specification of the VNF Instance see:
6373 http://osm-download.etsi.org/ftp/osm-doc/vnfr.html
6382 ArrayOfVnfInstanceInfo:
6385 $ref: '#/components/schemas/VnfInstanceInfo'
6388 NetSlice Template Information
6389 Only generic fields (_id, id, name) are described
6390 For a full specification of the NetSlice Template see:
6391 http://osm-download.etsi.org/ftp/osm-doc/nst.html
6395 description: NetSlice Template Identifier
6399 description: Human readable NetSlice Template Identifier
6402 description: Human readable name of the NetSlice Template
6407 $ref: '#/components/schemas/NstInfo'
6408 CreateNstInfoRequest:
6409 # A free list of key:value pairs
6411 additionalProperties: true
6418 NstInfoModifications:
6420 NetSlice Template Information
6421 Only generic fields (id, name) are described
6422 For a full specification of the NetSlice Template see:
6423 http://osm-download.etsi.org/ftp/osm-doc/nst.html
6427 description: NST Identifier
6430 description: NST Name
6434 NetSlice Instance Information
6435 Only generic fields (_id, id, name, description) are described
6436 For a full specification of the NetSlice Instance see:
6437 http://osm-download.etsi.org/ftp/osm-doc/nsi.html
6441 description: Identifier of the NetSlice instance.
6445 description: Identifier of the NetSlice instance.
6449 description: Human readable name of the NetSlice instance.
6452 description: Human readable description of the NetSlice instance.
6458 ArrayOfNetSliceInstance:
6461 $ref: '#/components/schemas/NetSliceInstance'
6463 # Substituted by InstantiateNsiRequest
6464 InstantiateNsiRequest:
6469 Human-readable name of the NetSlice instance to be created.
6473 Identifier of the NST that defines the NetSlice instance to be created.
6478 Identifier of the VIM Account where the NetSlice instance shall be created.
6494 additionalParamsForNsi:
6496 additionalProperties: true
6528 additionalParamsForNs:
6530 additionalProperties: true
6531 additionalParamsForVnf:
6540 additionalProperties: true
6541 additionalParamsForVdu:
6550 additionalProperties: true
6554 additionalProperties: false
6555 additionalParamsForKdu:
6564 additionalProperties: true
6568 additionalProperties: false
6572 additionalProperties: false
6611 additionalProperties: false
6626 floating-ip-required:
6630 additionalProperties: false
6634 additionalProperties: false
6673 additionalProperties: false
6687 additionalProperties: false
6689 additionalProperties: false
6697 additionalProperties: false
6698 internal-connection-point:
6711 additionalProperties: False
6716 additionalProperties: false
6721 additionalProperties: false
6740 additionalProperties: true
6748 additionalProperties: true
6756 additionalProperties: false
6757 vnfd-connection-point-ref:
6762 member-vnf-index-ref:
6764 vnfd-connection-point-ref:
6770 - member-vnf-index-ref
6771 - vnfd-connection-point-ref
6773 additionalProperties: false
6777 additionalProperties: false
6779 additionalProperties: false
6798 additionalProperties: true
6801 additionalProperties: false
6807 additionalProperties: false
6808 TerminateNsiRequest:
6813 Timestamp indicating the end time of the NSI, i.e. the NSI will be terminated
6814 automatically at this timestamp. Cardinality "0" indicates the NSI termination
6815 takes place immediately.
6824 $ref: '#/components/schemas/KeyValuePairs'
6833 # CreateNsiContentRequest:
6834 # Substituted by InstantiateNsiRequest
6835 CreateNsiContentResponse:
6858 isAutomaticInvocation:
6905 $ref: '#/components/schemas/NsiLcmOpOcc'
6949 $ref: '#/components/schemas/TokenInfo'
6972 project_role_mappings:
6994 $ref: '#/components/schemas/UserInfo'
6995 ProjectRoleMappings:
7007 additionalProperties: false
7008 ProjectRoleMappingsOpt:
7019 additionalProperties: false
7031 project_role_mappings:
7032 $ref: '#/components/schemas/ProjectRoleMappings'
7036 additionalProperties: false
7043 additionalProperties: true
7046 Array edition keys must start with '$'
7047 and follow the syntax defined in: https://osm.etsi.org/wikipub/index.php/NBI_API_Description
7057 - $ref: '#/components/schemas/ShortNameList'
7058 - $ref: '#/components/schemas/ArrayEditionSchema'
7059 project_role_mappings:
7060 $ref: '#/components/schemas/ProjectRoleMappings'
7061 add_project_role_mappings:
7062 $ref: '#/components/schemas/ProjectRoleMappings'
7063 remove_project_role_mappings:
7064 $ref: '#/components/schemas/ProjectRoleMappingsOpt'
7104 additionalProperties: false
7144 additionalProperties: false
7154 $ref: '#/components/schemas/QuotasInfo'
7158 $ref: '#/components/schemas/ProjectInfo'
7159 CreateProjectRequest:
7167 $ref: '#/components/schemas/QuotasInfo'
7170 additionalProperties: false
7179 $ref: '#/components/schemas/EditQuotasInfo'
7180 additionalProperties: false
7183 additionalProperties:
7187 Permissions keys must follow the syntax 'main_topic[:subtopic[:id[:component|action|etc]]]'
7188 Permission values are either true or false
7189 EditPermissionsInfo:
7191 additionalProperties:
7195 Permissions keys must follow the syntax 'main_topic[:subtopic[:id[:component|action|etc]]]'
7196 Permission values are either true, false, or null
7206 $ref: '#/components/schemas/PermissionsInfo'
7210 $ref: '#/components/schemas/RoleInfo'
7217 $ref: '#/components/schemas/PermissionsInfo'
7220 additionalProperties: false
7227 $ref: '#/components/schemas/EditPermissionsInfo'
7228 additionalProperties: false
7259 $ref: '#/components/schemas/VimType'
7271 additionalProperties: true
7275 $ref: '#/components/schemas/VimInfo'
7293 $ref: '#/components/schemas/VimType'
7305 additionalProperties: true
7313 additionalProperties: false
7326 $ref: '#/components/schemas/VimType'
7338 additionalProperties: true
7339 additionalProperties: false
7381 $ref: '#/components/schemas/WimType'
7391 additionalProperties: true
7395 $ref: '#/components/schemas/WimInfo'
7411 $ref: '#/components/schemas/WimType'
7421 additionalProperties: true
7426 additionalProperties: false
7447 additionalProperties: true
7448 additionalProperties: false
7487 - $ref: '#/components/schemas/SdnExtraProperties'
7488 - $ref: '#/components/schemas/SdnBasicProperties'
7492 $ref: '#/components/schemas/SdnInfo'
7495 - $ref: '#/components/schemas/SdnBasicProperties'
7502 additionalProperties: false
7505 - $ref: '#/components/schemas/SdnBasicProperties'
7506 additionalProperties: false
7562 additionalProperties: false
7586 $ref: '#/components/schemas/PduInterfaces'
7590 $ref: '#/components/schemas/PduInfo'
7611 $ref: '#/components/schemas/PduInterfaces'
7616 additionalProperties: false
7637 $ref: '#/components/schemas/PduInterfaces'
7638 additionalProperties: false
7643 additionalProperties: true
7661 additionalProperties: true
7668 $ref: '#/components/schemas/K8sClusterNetList'
7675 ArrayOfK8sClusterInfo:
7678 $ref: '#/components/schemas/K8sClusterInfo'
7679 CreateK8sClusterRequest:
7693 additionalProperties: true
7700 $ref: '#/components/schemas/K8sClusterNetList'
7713 additionalProperties: false
7714 EditK8sClusterRequest:
7723 additionalProperties: true
7730 $ref: '#/components/schemas/K8sClusterNetList'
7737 additionalProperties: false
7754 $ref: '#/components/schemas/K8sRepoType'
7761 $ref: '#/components/schemas/K8sRepoInfo'
7762 CreateK8sRepoRequest:
7770 $ref: '#/components/schemas/K8sRepoType'
7778 additionalProperties: false
7782 CreateNsdInfoRequest:
7786 $ref: '#/components/schemas/CreateNsdInfoRequest'
7789 $ref: '#/components/schemas/CreateNsdInfoRequest'
7790 NsdInfoModifications:
7794 $ref: '#/components/schemas/NsdInfoModifications'
7797 $ref: '#/components/schemas/NsdInfoModifications'
7802 $ref: '#/components/schemas/NsDescriptor'
7807 $ref: '#/components/schemas/NsPackage'
7808 CreateVnfPkgInfoRequest:
7812 $ref: '#/components/schemas/CreateVnfPkgInfoRequest'
7815 $ref: '#/components/schemas/CreateVnfPkgInfoRequest'
7816 VnfPkgInfoModifications:
7820 $ref: '#/components/schemas/VnfPkgInfoModifications'
7823 $ref: '#/components/schemas/VnfPkgInfoModifications'
7828 $ref: '#/components/schemas/VnfPackage'
7833 $ref: '#/components/schemas/VnfDescriptor'
7835 # Substituted by InstantiateNsRequest
7836 InstantiateNsRequest:
7840 $ref: '#/components/schemas/InstantiateNsRequest'
7843 $ref: '#/components/schemas/InstantiateNsRequest'
7848 $ref: '#/components/schemas/ScaleNsRequest'
7851 $ref: '#/components/schemas/ScaleNsRequest'
7856 $ref: '#/components/schemas/TerminateNsRequest'
7859 $ref: '#/components/schemas/TerminateNsRequest'
7860 # CreateNSinstanceContentRequest:
7861 # Substituted by InstantiateNsRequest
7862 CreateNstInfoRequest:
7866 $ref: '#/components/schemas/CreateNstInfoRequest'
7869 $ref: '#/components/schemas/CreateNstInfoRequest'
7874 $ref: '#/components/schemas/NetSliceTemplate'
7879 $ref: '#/components/schemas/NetSlicePackage'
7880 NstInfoModifications:
7884 $ref: '#/components/schemas/NstInfoModifications'
7887 $ref: '#/components/schemas/NstInfoModifications'
7889 # Substituted by InstantiateNsiRequest
7890 InstantiateNsiRequest:
7894 $ref: '#/components/schemas/InstantiateNsiRequest'
7897 $ref: '#/components/schemas/InstantiateNsiRequest'
7898 TerminateNsiRequest:
7902 $ref: '#/components/schemas/TerminateNsiRequest'
7905 $ref: '#/components/schemas/TerminateNsiRequest'
7910 $ref: '#/components/schemas/NsiActionRequest'
7913 $ref: '#/components/schemas/NsiActionRequest'
7914 # CreateNsiContentRequest:
7915 # Substituted by InstantiateNsiRequest
7920 $ref: '#/components/schemas/CreateTokenRequest'
7923 $ref: '#/components/schemas/CreateTokenRequest'
7928 $ref: '#/components/schemas/CreateUserRequest'
7931 $ref: '#/components/schemas/CreateUserRequest'
7936 $ref: '#/components/schemas/EditUserRequest'
7939 $ref: '#/components/schemas/EditUserRequest'
7940 CreateProjectRequest:
7944 $ref: '#/components/schemas/CreateProjectRequest'
7947 $ref: '#/components/schemas/CreateProjectRequest'
7952 $ref: '#/components/schemas/EditProjectRequest'
7955 $ref: '#/components/schemas/EditProjectRequest'
7960 $ref: '#/components/schemas/CreateRoleRequest'
7963 $ref: '#/components/schemas/CreateRoleRequest'
7968 $ref: '#/components/schemas/EditRoleRequest'
7971 $ref: '#/components/schemas/EditRoleRequest'
7976 $ref: '#/components/schemas/CreateVimRequest'
7979 $ref: '#/components/schemas/CreateVimRequest'
7984 $ref: '#/components/schemas/EditVimRequest'
7987 $ref: '#/components/schemas/EditVimRequest'
7992 $ref: '#/components/schemas/CreateWimRequest'
7995 $ref: '#/components/schemas/CreateWimRequest'
8000 $ref: '#/components/schemas/EditWimRequest'
8003 $ref: '#/components/schemas/EditWimRequest'
8008 $ref: '#/components/schemas/CreateSdnRequest'
8011 $ref: '#/components/schemas/CreateSdnRequest'
8016 $ref: '#/components/schemas/EditSdnRequest'
8019 $ref: '#/components/schemas/EditSdnRequest'
8024 $ref: '#/components/schemas/CreatePduRequest'
8027 $ref: '#/components/schemas/CreatePduRequest'
8032 $ref: '#/components/schemas/EditPduRequest'
8035 $ref: '#/components/schemas/EditPduRequest'
8036 CreateK8sClusterRequest:
8040 $ref: '#/components/schemas/CreateK8sClusterRequest'
8043 $ref: '#/components/schemas/CreateK8sClusterRequest'
8044 EditK8sClusterRequest:
8048 $ref: '#/components/schemas/EditK8sClusterRequest'
8051 $ref: '#/components/schemas/EditK8sClusterRequest'
8052 CreateK8sRepoRequest:
8056 $ref: '#/components/schemas/CreateK8sRepoRequest'
8059 $ref: '#/components/schemas/CreateK8sRepoRequest'
8060 # END REQUEST BODIES