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
37 description: Management operations of Administration items
45 '/nsd/v1/ns_descriptors':
49 summary: Query information about multiple NS descriptor resources
50 description: Query information about multiple NS descriptor resources
58 $ref: '#/components/schemas/ArrayOfNsdInfo'
61 $ref: '#/components/schemas/ArrayOfNsdInfo'
63 $ref: '#/components/responses/BadRequest'
65 $ref: '#/components/responses/Unauthorized'
67 $ref: '#/components/responses/Forbidden'
69 $ref: '#/components/responses/NotFound'
71 $ref: '#/components/responses/MethodNotAllowed'
73 $ref: '#/components/responses/NotAcceptable'
75 $ref: '#/components/responses/Conflict'
77 $ref: '#/components/responses/UnprocessableEntity'
79 $ref: '#/components/responses/InternalServerError'
81 $ref: '#/components/responses/ServiceUnavailable'
83 $ref: '#/components/responses/UnexpectedError'
85 $ref: '#/components/responses/UnexpectedError'
89 summary: Create a new NS descriptor resource
90 description: Create a new NS descriptor resource
93 $ref: '#/components/requestBodies/CreateNsdInfoRequest'
105 $ref: '#/components/schemas/ObjectId'
108 $ref: '#/components/schemas/ObjectId'
110 $ref: '#/components/responses/BadRequest'
112 $ref: '#/components/responses/Unauthorized'
114 $ref: '#/components/responses/Forbidden'
116 $ref: '#/components/responses/NotFound'
118 $ref: '#/components/responses/MethodNotAllowed'
120 $ref: '#/components/responses/NotAcceptable'
122 $ref: '#/components/responses/Conflict'
124 $ref: '#/components/responses/UnprocessableEntity'
126 $ref: '#/components/responses/InternalServerError'
128 $ref: '#/components/responses/ServiceUnavailable'
130 $ref: '#/components/responses/UnexpectedError'
132 $ref: '#/components/responses/UnexpectedError'
133 '/nsd/v1/ns_descriptors/{nsdInfoId}':
138 description: NSD Info ID
144 summary: Read information about an individual NS descriptor resource
145 description: Read information about an individual NS descriptor resource
153 $ref: '#/components/schemas/NsdInfo'
156 $ref: '#/components/schemas/NsdInfo'
158 $ref: '#/components/responses/BadRequest'
160 $ref: '#/components/responses/Unauthorized'
162 $ref: '#/components/responses/Forbidden'
164 $ref: '#/components/responses/NotFound'
166 $ref: '#/components/responses/MethodNotAllowed'
168 $ref: '#/components/responses/NotAcceptable'
170 $ref: '#/components/responses/Conflict'
172 $ref: '#/components/responses/UnprocessableEntity'
174 $ref: '#/components/responses/InternalServerError'
176 $ref: '#/components/responses/ServiceUnavailable'
178 $ref: '#/components/responses/UnexpectedError'
180 $ref: '#/components/responses/UnexpectedError'
184 summary: Delete an individual NS descriptor resource
185 description: Delete an individual NS descriptor resource
186 operationId: deleteNSD
189 description: No Content
191 $ref: '#/components/responses/BadRequest'
193 $ref: '#/components/responses/Unauthorized'
195 $ref: '#/components/responses/Forbidden'
197 $ref: '#/components/responses/NotFound'
199 $ref: '#/components/responses/MethodNotAllowed'
201 $ref: '#/components/responses/NotAcceptable'
203 $ref: '#/components/responses/Conflict'
205 $ref: '#/components/responses/UnprocessableEntity'
207 $ref: '#/components/responses/InternalServerError'
209 $ref: '#/components/responses/ServiceUnavailable'
211 $ref: '#/components/responses/UnexpectedError'
213 $ref: '#/components/responses/UnexpectedError'
217 summary: Modify the data of an individual NS descriptor resource
218 description: Modify the data of an individual NS descriptor resource
219 operationId: updateNSD
221 $ref: '#/components/requestBodies/NsdInfoModifications'
224 description: No Content
226 $ref: '#/components/responses/BadRequest'
228 $ref: '#/components/responses/Unauthorized'
230 $ref: '#/components/responses/Forbidden'
232 $ref: '#/components/responses/NotFound'
234 $ref: '#/components/responses/MethodNotAllowed'
236 $ref: '#/components/responses/NotAcceptable'
238 $ref: '#/components/responses/Conflict'
240 $ref: '#/components/responses/UnprocessableEntity'
242 $ref: '#/components/responses/InternalServerError'
244 $ref: '#/components/responses/ServiceUnavailable'
246 $ref: '#/components/responses/UnexpectedError'
248 $ref: '#/components/responses/UnexpectedError'
249 '/nsd/v1/ns_descriptors/{nsdInfoId}/nsd_content':
254 description: NSD Info ID
260 summary: Fetch the content of a NSD
261 description: Fetch the content of a NSD
262 operationId: getNSDcontent
269 $ref: '#/components/schemas/NsPackage'
271 description: Partial Content
279 $ref: '#/components/schemas/NsPackage'
281 $ref: '#/components/responses/BadRequest'
283 $ref: '#/components/responses/Unauthorized'
285 $ref: '#/components/responses/Forbidden'
287 $ref: '#/components/responses/NotFound'
289 $ref: '#/components/responses/MethodNotAllowed'
291 $ref: '#/components/responses/NotAcceptable'
293 $ref: '#/components/responses/Conflict'
295 $ref: '#/components/responses/UnprocessableEntity'
297 $ref: '#/components/responses/InternalServerError'
299 $ref: '#/components/responses/ServiceUnavailable'
301 $ref: '#/components/responses/UnexpectedError'
303 $ref: '#/components/responses/UnexpectedError'
307 summary: Upload the content of a NSD
308 description: Upload the content of a NSD
309 operationId: updateNSDcontent
311 $ref: '#/components/requestBodies/NsPackage'
314 description: Accepted
316 description: No Content
318 $ref: '#/components/responses/BadRequest'
320 $ref: '#/components/responses/Unauthorized'
322 $ref: '#/components/responses/Forbidden'
324 $ref: '#/components/responses/NotFound'
326 $ref: '#/components/responses/MethodNotAllowed'
328 $ref: '#/components/responses/NotAcceptable'
330 $ref: '#/components/responses/Conflict'
332 $ref: '#/components/responses/UnprocessableEntity'
334 $ref: '#/components/responses/InternalServerError'
336 $ref: '#/components/responses/ServiceUnavailable'
338 $ref: '#/components/responses/UnexpectedError'
340 $ref: '#/components/responses/UnexpectedError'
341 '/nsd/v1/ns_descriptors/{nsdInfoId}/artifacts/{artifactPath}':
346 description: NS Package ID
352 description: Artifact Path
358 summary: Fetch individual NS package artifact
359 description: Fetch individual NS package artifact
360 operationId: getNsPkgArtifact
365 application/octet-stream:
370 description: Partial Content
376 application/octet-stream:
381 $ref: '#/components/responses/BadRequest'
383 $ref: '#/components/responses/Unauthorized'
385 $ref: '#/components/responses/Forbidden'
387 $ref: '#/components/responses/NotFound'
389 $ref: '#/components/responses/MethodNotAllowed'
391 $ref: '#/components/responses/NotAcceptable'
393 $ref: '#/components/responses/Conflict'
395 $ref: '#/components/responses/UnprocessableEntity'
397 $ref: '#/components/responses/InternalServerError'
399 $ref: '#/components/responses/ServiceUnavailable'
401 $ref: '#/components/responses/UnexpectedError'
403 $ref: '#/components/responses/UnexpectedError'
404 '/nsd/v1/ns_descriptors/{nsdInfoId}/nsd':
409 description: NS Package ID
415 summary: Read NSD of an on-boarded NS package
416 description: Read NSD of an on-boarded NS package
417 operationId: getNsPkgNsd
424 $ref: '#/components/schemas/NsDescriptor'
426 $ref: '#/components/responses/BadRequest'
428 $ref: '#/components/responses/Unauthorized'
430 $ref: '#/components/responses/Forbidden'
432 $ref: '#/components/responses/NotFound'
434 $ref: '#/components/responses/MethodNotAllowed'
436 $ref: '#/components/responses/NotAcceptable'
438 $ref: '#/components/responses/Conflict'
440 $ref: '#/components/responses/UnprocessableEntity'
442 $ref: '#/components/responses/InternalServerError'
444 $ref: '#/components/responses/ServiceUnavailable'
446 $ref: '#/components/responses/UnexpectedError'
448 $ref: '#/components/responses/UnexpectedError'
449 '/nsd/v1/ns_descriptors_content':
453 summary: Upload a NS package by providing the content of the NS package
454 description: Upload a NS package by providing the content of the NS package
455 operationId: uploadNsPkgsContent
460 $ref: '#/components/schemas/NsPackage'
472 $ref: '#/components/schemas/ObjectId'
475 $ref: '#/components/schemas/ObjectId'
477 description: Accepted
479 description: No Content
481 $ref: '#/components/responses/BadRequest'
483 $ref: '#/components/responses/Unauthorized'
485 $ref: '#/components/responses/Forbidden'
487 $ref: '#/components/responses/NotFound'
489 $ref: '#/components/responses/MethodNotAllowed'
491 $ref: '#/components/responses/NotAcceptable'
493 $ref: '#/components/responses/Conflict'
495 $ref: '#/components/responses/UnprocessableEntity'
497 $ref: '#/components/responses/InternalServerError'
499 $ref: '#/components/responses/ServiceUnavailable'
501 $ref: '#/components/responses/UnexpectedError'
503 $ref: '#/components/responses/UnexpectedError'
507 summary: Query information about multiple NS package resources
508 description: Query information about multiple NS package resources
509 operationId: getNsPkgsContent
516 $ref: '#/components/schemas/ArrayOfNsdInfo'
519 $ref: '#/components/schemas/ArrayOfNsdInfo'
521 description: Partial Content
527 application/octet-stream:
532 $ref: '#/components/responses/BadRequest'
534 $ref: '#/components/responses/Unauthorized'
536 $ref: '#/components/responses/Forbidden'
538 $ref: '#/components/responses/NotFound'
540 $ref: '#/components/responses/MethodNotAllowed'
542 $ref: '#/components/responses/NotAcceptable'
544 $ref: '#/components/responses/Conflict'
546 $ref: '#/components/responses/UnprocessableEntity'
548 $ref: '#/components/responses/InternalServerError'
550 $ref: '#/components/responses/ServiceUnavailable'
552 $ref: '#/components/responses/UnexpectedError'
554 $ref: '#/components/responses/UnexpectedError'
555 '/nsd/v1/ns_descriptors_content/{nsdInfoId}':
560 description: NS Package ID
566 summary: Read information about an individual NS package resource
567 description: Read information about an individual NS package resource
568 operationId: getNsPkgsIdContent
575 $ref: '#/components/schemas/NsdInfo'
578 $ref: '#/components/schemas/NsdInfo'
580 $ref: '#/components/responses/BadRequest'
582 $ref: '#/components/responses/Unauthorized'
584 $ref: '#/components/responses/Forbidden'
586 $ref: '#/components/responses/NotFound'
588 $ref: '#/components/responses/MethodNotAllowed'
590 $ref: '#/components/responses/NotAcceptable'
592 $ref: '#/components/responses/Conflict'
594 $ref: '#/components/responses/UnprocessableEntity'
596 $ref: '#/components/responses/InternalServerError'
598 $ref: '#/components/responses/ServiceUnavailable'
600 $ref: '#/components/responses/UnexpectedError'
602 $ref: '#/components/responses/UnexpectedError'
606 summary: Modify an individual NS package resource
607 description: Modify an individual NS package resource
608 operationId: updateNsPkgsIdContent
610 $ref: '#/components/requestBodies/NsdInfoModifications'
613 description: No Content
615 $ref: '#/components/responses/BadRequest'
617 $ref: '#/components/responses/Unauthorized'
619 $ref: '#/components/responses/Forbidden'
621 $ref: '#/components/responses/NotFound'
623 $ref: '#/components/responses/MethodNotAllowed'
625 $ref: '#/components/responses/NotAcceptable'
627 $ref: '#/components/responses/Conflict'
629 $ref: '#/components/responses/UnprocessableEntity'
631 $ref: '#/components/responses/InternalServerError'
633 $ref: '#/components/responses/ServiceUnavailable'
635 $ref: '#/components/responses/UnexpectedError'
637 $ref: '#/components/responses/UnexpectedError'
641 summary: Delete an individual NS package resource
642 description: Delete an individual NS package resource
643 operationId: deleteNSPkgsIdContent
646 description: No Content
648 $ref: '#/components/responses/BadRequest'
650 $ref: '#/components/responses/Unauthorized'
652 $ref: '#/components/responses/Forbidden'
654 $ref: '#/components/responses/NotFound'
656 $ref: '#/components/responses/MethodNotAllowed'
658 $ref: '#/components/responses/NotAcceptable'
660 $ref: '#/components/responses/Conflict'
662 $ref: '#/components/responses/UnprocessableEntity'
664 $ref: '#/components/responses/InternalServerError'
666 $ref: '#/components/responses/ServiceUnavailable'
668 $ref: '#/components/responses/UnexpectedError'
670 $ref: '#/components/responses/UnexpectedError'
674 '/vnfpkgm/v1/vnf_packages':
678 summary: Query information about multiple VNF package resources
679 description: Query information about multiple VNF package resources
680 operationId: getVnfPkgs
687 $ref: '#/components/schemas/ArrayOfVnfPkgInfo'
690 $ref: '#/components/schemas/ArrayOfVnfPkgInfo'
692 $ref: '#/components/responses/BadRequest'
694 $ref: '#/components/responses/Unauthorized'
696 $ref: '#/components/responses/Forbidden'
698 $ref: '#/components/responses/NotFound'
700 $ref: '#/components/responses/MethodNotAllowed'
702 $ref: '#/components/responses/NotAcceptable'
704 $ref: '#/components/responses/Conflict'
706 $ref: '#/components/responses/UnprocessableEntity'
708 $ref: '#/components/responses/InternalServerError'
710 $ref: '#/components/responses/ServiceUnavailable'
712 $ref: '#/components/responses/UnexpectedError'
714 $ref: '#/components/responses/UnexpectedError'
718 summary: Create a new VNF package resource
719 description: Create a new VNF package resource
720 operationId: addVnfPkg
722 $ref: '#/components/requestBodies/CreateVnfPkgInfoRequest'
734 $ref: '#/components/schemas/ObjectId'
737 $ref: '#/components/schemas/ObjectId'
739 $ref: '#/components/responses/BadRequest'
741 $ref: '#/components/responses/Unauthorized'
743 $ref: '#/components/responses/Forbidden'
745 $ref: '#/components/responses/NotFound'
747 $ref: '#/components/responses/MethodNotAllowed'
749 $ref: '#/components/responses/NotAcceptable'
751 $ref: '#/components/responses/Conflict'
753 $ref: '#/components/responses/UnprocessableEntity'
755 $ref: '#/components/responses/InternalServerError'
757 $ref: '#/components/responses/ServiceUnavailable'
759 $ref: '#/components/responses/UnexpectedError'
761 $ref: '#/components/responses/UnexpectedError'
762 '/vnfpkgm/v1/vnf_packages/{vnfPkgId}':
767 description: VNF Package ID
773 summary: Read information about an individual VNF package resource
774 description: Read information about an individual VNF package resource
775 operationId: getVnfPkg
782 $ref: '#/components/schemas/VnfPkgInfo'
785 $ref: '#/components/schemas/VnfPkgInfo'
787 $ref: '#/components/responses/BadRequest'
789 $ref: '#/components/responses/Unauthorized'
791 $ref: '#/components/responses/Forbidden'
793 $ref: '#/components/responses/NotFound'
795 $ref: '#/components/responses/MethodNotAllowed'
797 $ref: '#/components/responses/NotAcceptable'
799 $ref: '#/components/responses/Conflict'
801 $ref: '#/components/responses/UnprocessableEntity'
803 $ref: '#/components/responses/InternalServerError'
805 $ref: '#/components/responses/ServiceUnavailable'
807 $ref: '#/components/responses/UnexpectedError'
809 $ref: '#/components/responses/UnexpectedError'
813 summary: Delete an individual VNF package resource
814 description: Delete an individual VNF package resource
815 operationId: deleteVnfPkg
818 description: No Content
820 $ref: '#/components/responses/BadRequest'
822 $ref: '#/components/responses/Unauthorized'
824 $ref: '#/components/responses/Forbidden'
826 $ref: '#/components/responses/NotFound'
828 $ref: '#/components/responses/MethodNotAllowed'
830 $ref: '#/components/responses/NotAcceptable'
832 $ref: '#/components/responses/Conflict'
834 $ref: '#/components/responses/UnprocessableEntity'
836 $ref: '#/components/responses/InternalServerError'
838 $ref: '#/components/responses/ServiceUnavailable'
840 $ref: '#/components/responses/UnexpectedError'
842 $ref: '#/components/responses/UnexpectedError'
846 summary: Modify an individual VNF package resource
847 description: Modify an individual VNF package resource
848 operationId: updateVnfPkg
850 $ref: '#/components/requestBodies/VnfPkgInfoModifications'
853 description: No Content
855 $ref: '#/components/responses/BadRequest'
857 $ref: '#/components/responses/Unauthorized'
859 $ref: '#/components/responses/Forbidden'
861 $ref: '#/components/responses/NotFound'
863 $ref: '#/components/responses/MethodNotAllowed'
865 $ref: '#/components/responses/NotAcceptable'
867 $ref: '#/components/responses/Conflict'
869 $ref: '#/components/responses/UnprocessableEntity'
871 $ref: '#/components/responses/InternalServerError'
873 $ref: '#/components/responses/ServiceUnavailable'
875 $ref: '#/components/responses/UnexpectedError'
877 $ref: '#/components/responses/UnexpectedError'
878 '/vnfpkgm/v1/vnf_packages/{vnfPkgId}/vnfd':
883 description: VNF Package ID
889 summary: Read VNFD of an on-boarded VNF package
890 description: Read VNFD of an on-boarded VNF package
891 operationId: getVnfPkgVnfd
898 $ref: '#/components/schemas/VnfDescriptor'
900 $ref: '#/components/responses/BadRequest'
902 $ref: '#/components/responses/Unauthorized'
904 $ref: '#/components/responses/Forbidden'
906 $ref: '#/components/responses/NotFound'
908 $ref: '#/components/responses/MethodNotAllowed'
910 $ref: '#/components/responses/NotAcceptable'
912 $ref: '#/components/responses/Conflict'
914 $ref: '#/components/responses/UnprocessableEntity'
916 $ref: '#/components/responses/InternalServerError'
918 $ref: '#/components/responses/ServiceUnavailable'
920 $ref: '#/components/responses/UnexpectedError'
922 $ref: '#/components/responses/UnexpectedError'
923 '/vnfpkgm/v1/vnf_packages/{vnfPkgId}/package_content':
928 description: VNF Package ID
934 summary: Fetch an on-boarded VNF package
935 description: Fetch an on-boarded VNF package
936 operationId: getVnfPkgContent
943 $ref: '#/components/schemas/VnfPackage'
945 description: Partial Content
953 $ref: '#/components/schemas/VnfPackage'
955 $ref: '#/components/responses/BadRequest'
957 $ref: '#/components/responses/Unauthorized'
959 $ref: '#/components/responses/Forbidden'
961 $ref: '#/components/responses/NotFound'
963 $ref: '#/components/responses/MethodNotAllowed'
965 $ref: '#/components/responses/NotAcceptable'
967 $ref: '#/components/responses/Conflict'
969 $ref: '#/components/responses/UnprocessableEntity'
971 $ref: '#/components/responses/InternalServerError'
973 $ref: '#/components/responses/ServiceUnavailable'
975 $ref: '#/components/responses/UnexpectedError'
977 $ref: '#/components/responses/UnexpectedError'
981 summary: Upload a VNF package by providing the content of the VNF package
982 description: Upload a VNF package by providing the content of the VNF package
983 operationId: uploadVnfPkgContent
988 $ref: '#/components/schemas/VnfPackage'
991 description: Accepted
993 description: No Content
995 $ref: '#/components/responses/BadRequest'
997 $ref: '#/components/responses/Unauthorized'
999 $ref: '#/components/responses/Forbidden'
1001 $ref: '#/components/responses/NotFound'
1003 $ref: '#/components/responses/MethodNotAllowed'
1005 $ref: '#/components/responses/NotAcceptable'
1007 $ref: '#/components/responses/Conflict'
1009 $ref: '#/components/responses/UnprocessableEntity'
1011 $ref: '#/components/responses/InternalServerError'
1013 $ref: '#/components/responses/ServiceUnavailable'
1015 $ref: '#/components/responses/UnexpectedError'
1017 $ref: '#/components/responses/UnexpectedError'
1018 '/vnfpkgm/v1/vnf_packages/{vnfPkgId}/artifacts/{artifactPath}':
1023 description: VNF Package ID
1026 - name: artifactPath
1029 description: Artifact Path
1035 summary: Fetch individual VNF package artifact
1036 description: Fetch individual VNF package artifact
1037 operationId: getVnfPkgArtifact
1042 application/octet-stream:
1047 description: Partial Content
1053 application/octet-stream:
1058 $ref: '#/components/responses/BadRequest'
1060 $ref: '#/components/responses/Unauthorized'
1062 $ref: '#/components/responses/Forbidden'
1064 $ref: '#/components/responses/NotFound'
1066 $ref: '#/components/responses/MethodNotAllowed'
1068 $ref: '#/components/responses/NotAcceptable'
1070 $ref: '#/components/responses/Conflict'
1072 $ref: '#/components/responses/UnprocessableEntity'
1074 $ref: '#/components/responses/InternalServerError'
1076 $ref: '#/components/responses/ServiceUnavailable'
1078 $ref: '#/components/responses/UnexpectedError'
1080 $ref: '#/components/responses/UnexpectedError'
1081 '/vnfpkgm/v1/vnf_packages_content':
1085 summary: Upload a VNF package by providing the content of the VNF package
1086 description: Upload a VNF package by providing the content of the VNF package
1087 operationId: uploadVnfPkgsContent
1092 $ref: '#/components/schemas/VnfPackage'
1095 description: Created
1104 $ref: '#/components/schemas/ObjectId'
1107 $ref: '#/components/schemas/ObjectId'
1109 description: Accepted
1111 description: No Content
1113 $ref: '#/components/responses/BadRequest'
1115 $ref: '#/components/responses/Unauthorized'
1117 $ref: '#/components/responses/Forbidden'
1119 $ref: '#/components/responses/NotFound'
1121 $ref: '#/components/responses/MethodNotAllowed'
1123 $ref: '#/components/responses/NotAcceptable'
1125 $ref: '#/components/responses/Conflict'
1127 $ref: '#/components/responses/UnprocessableEntity'
1129 $ref: '#/components/responses/InternalServerError'
1131 $ref: '#/components/responses/ServiceUnavailable'
1133 $ref: '#/components/responses/UnexpectedError'
1135 $ref: '#/components/responses/UnexpectedError'
1139 summary: Query information about multiple VNF package resources
1140 description: Query information about multiple VNF package resources
1141 operationId: getVnfPkgsContent
1148 $ref: '#/components/schemas/ArrayOfVnfPkgInfo'
1151 $ref: '#/components/schemas/ArrayOfVnfPkgInfo'
1153 description: Partial Content
1159 application/octet-stream:
1164 $ref: '#/components/responses/BadRequest'
1166 $ref: '#/components/responses/Unauthorized'
1168 $ref: '#/components/responses/Forbidden'
1170 $ref: '#/components/responses/NotFound'
1172 $ref: '#/components/responses/MethodNotAllowed'
1174 $ref: '#/components/responses/NotAcceptable'
1176 $ref: '#/components/responses/Conflict'
1178 $ref: '#/components/responses/UnprocessableEntity'
1180 $ref: '#/components/responses/InternalServerError'
1182 $ref: '#/components/responses/ServiceUnavailable'
1184 $ref: '#/components/responses/UnexpectedError'
1186 $ref: '#/components/responses/UnexpectedError'
1187 '/vnfpkgm/v1/vnf_packages_content/{packageContentId}':
1189 - name: packageContentId
1192 description: VNF Package Content ID
1198 summary: Read information about an individual VNF package resource
1199 description: Read information about an individual VNF package resource
1200 operationId: getVnfPkgsIdContent
1207 $ref: '#/components/schemas/VnfPkgInfo'
1210 $ref: '#/components/schemas/VnfPkgInfo'
1212 $ref: '#/components/responses/BadRequest'
1214 $ref: '#/components/responses/Unauthorized'
1216 $ref: '#/components/responses/Forbidden'
1218 $ref: '#/components/responses/NotFound'
1220 $ref: '#/components/responses/MethodNotAllowed'
1222 $ref: '#/components/responses/NotAcceptable'
1224 $ref: '#/components/responses/Conflict'
1226 $ref: '#/components/responses/UnprocessableEntity'
1228 $ref: '#/components/responses/InternalServerError'
1230 $ref: '#/components/responses/ServiceUnavailable'
1232 $ref: '#/components/responses/UnexpectedError'
1234 $ref: '#/components/responses/UnexpectedError'
1238 summary: Modify an individual VNF package resource
1239 description: Modify an individual VNF package resource
1240 operationId: updateVnfPkgsIdContent
1242 $ref: '#/components/requestBodies/VnfPkgInfoModifications'
1245 description: No Content
1247 $ref: '#/components/responses/BadRequest'
1249 $ref: '#/components/responses/Unauthorized'
1251 $ref: '#/components/responses/Forbidden'
1253 $ref: '#/components/responses/NotFound'
1255 $ref: '#/components/responses/MethodNotAllowed'
1257 $ref: '#/components/responses/NotAcceptable'
1259 $ref: '#/components/responses/Conflict'
1261 $ref: '#/components/responses/UnprocessableEntity'
1263 $ref: '#/components/responses/InternalServerError'
1265 $ref: '#/components/responses/ServiceUnavailable'
1267 $ref: '#/components/responses/UnexpectedError'
1269 $ref: '#/components/responses/UnexpectedError'
1273 summary: Delete an individual VNF package resource
1274 description: Delete an individual VNF package resource
1275 operationId: deleteVnfPkgsIdContent
1278 description: No Content
1280 $ref: '#/components/responses/BadRequest'
1282 $ref: '#/components/responses/Unauthorized'
1284 $ref: '#/components/responses/Forbidden'
1286 $ref: '#/components/responses/NotFound'
1288 $ref: '#/components/responses/MethodNotAllowed'
1290 $ref: '#/components/responses/NotAcceptable'
1292 $ref: '#/components/responses/Conflict'
1294 $ref: '#/components/responses/UnprocessableEntity'
1296 $ref: '#/components/responses/InternalServerError'
1298 $ref: '#/components/responses/ServiceUnavailable'
1300 $ref: '#/components/responses/UnexpectedError'
1302 $ref: '#/components/responses/UnexpectedError'
1305 # BEGIN NS Instances
1306 '/nslcm/v1/ns_instances':
1310 summary: Query information about multiple NS instances
1311 description: Query information about multiple NS isntances
1312 operationId: getNSinstances
1319 $ref: '#/components/schemas/ArrayOfNsInstance'
1322 $ref: '#/components/schemas/ArrayOfNsInstance'
1324 $ref: '#/components/responses/BadRequest'
1326 $ref: '#/components/responses/Unauthorized'
1328 $ref: '#/components/responses/Forbidden'
1330 $ref: '#/components/responses/NotFound'
1332 $ref: '#/components/responses/MethodNotAllowed'
1334 $ref: '#/components/responses/NotAcceptable'
1336 $ref: '#/components/responses/Conflict'
1338 $ref: '#/components/responses/UnprocessableEntity'
1340 $ref: '#/components/responses/InternalServerError'
1342 $ref: '#/components/responses/ServiceUnavailable'
1344 $ref: '#/components/responses/UnexpectedError'
1346 $ref: '#/components/responses/UnexpectedError'
1350 summary: Create a new NS instance resource
1351 description: Create a new NS instance resource
1352 operationId: addNSinstance
1354 $ref: '#/components/requestBodies/InstantiateNsRequest'
1357 description: Created
1366 $ref: '#/components/schemas/ObjectId'
1369 $ref: '#/components/schemas/ObjectId'
1371 $ref: '#/components/responses/BadRequest'
1373 $ref: '#/components/responses/Unauthorized'
1375 $ref: '#/components/responses/Forbidden'
1377 $ref: '#/components/responses/NotFound'
1379 $ref: '#/components/responses/MethodNotAllowed'
1381 $ref: '#/components/responses/NotAcceptable'
1383 $ref: '#/components/responses/Conflict'
1385 $ref: '#/components/responses/UnprocessableEntity'
1387 $ref: '#/components/responses/InternalServerError'
1389 $ref: '#/components/responses/ServiceUnavailable'
1391 $ref: '#/components/responses/UnexpectedError'
1393 $ref: '#/components/responses/UnexpectedError'
1394 '/nslcm/v1/ns_instances/{nsInstanceId}':
1396 - name: nsInstanceId
1399 description: NS Instance ID
1405 summary: Read an individual NS instance resource
1406 description: Read an individual NS instance resource
1407 operationId: getNSinstance
1414 $ref: '#/components/schemas/NsInstance'
1417 $ref: '#/components/schemas/NsInstance'
1419 $ref: '#/components/responses/BadRequest'
1421 $ref: '#/components/responses/Unauthorized'
1423 $ref: '#/components/responses/Forbidden'
1425 $ref: '#/components/responses/NotFound'
1427 $ref: '#/components/responses/MethodNotAllowed'
1429 $ref: '#/components/responses/NotAcceptable'
1431 $ref: '#/components/responses/Conflict'
1433 $ref: '#/components/responses/UnprocessableEntity'
1435 $ref: '#/components/responses/InternalServerError'
1437 $ref: '#/components/responses/ServiceUnavailable'
1439 $ref: '#/components/responses/UnexpectedError'
1441 $ref: '#/components/responses/UnexpectedError'
1445 summary: Delete an individual NS instance resource
1446 description: Delete an individual NS instance resource
1447 operationId: deleteNSinstance
1450 description: No Content
1452 $ref: '#/components/responses/BadRequest'
1454 $ref: '#/components/responses/Unauthorized'
1456 $ref: '#/components/responses/Forbidden'
1458 $ref: '#/components/responses/NotFound'
1460 $ref: '#/components/responses/MethodNotAllowed'
1462 $ref: '#/components/responses/NotAcceptable'
1464 $ref: '#/components/responses/Conflict'
1466 $ref: '#/components/responses/UnprocessableEntity'
1468 $ref: '#/components/responses/InternalServerError'
1470 $ref: '#/components/responses/ServiceUnavailable'
1472 $ref: '#/components/responses/UnexpectedError'
1474 $ref: '#/components/responses/UnexpectedError'
1475 '/nslcm/v1/ns_instances/{nsInstanceId}/instantiate':
1477 - name: nsInstanceId
1480 description: NS Instance ID
1486 summary: Instantiate a NS
1488 Instantiate a NS. The precondition is that the NS instance must have
1489 been created and must be in NOT_INSTANTIATED state. As a result of the
1490 success of this operation, the NFVO creates a "NS Lifecycle Operation
1491 Occurrence" resource for the request, and the NS instance state becomes
1493 operationId: instantiateNSinstance
1495 $ref: '#/components/requestBodies/InstantiateNsRequest'
1498 description: Accepted
1502 It must point to the new "NS Lifecycle Operation Occurrence"
1503 resource, i.e. an URI like ".../ns_lcm_op_occs/{nsLcmOpOccId}"
1510 $ref: '#/components/schemas/ObjectId'
1513 $ref: '#/components/schemas/ObjectId'
1515 $ref: '#/components/responses/BadRequest'
1517 $ref: '#/components/responses/Unauthorized'
1519 $ref: '#/components/responses/Forbidden'
1521 $ref: '#/components/responses/NotFound'
1523 $ref: '#/components/responses/MethodNotAllowed'
1525 $ref: '#/components/responses/NotAcceptable'
1527 $ref: '#/components/responses/Conflict'
1529 $ref: '#/components/responses/UnprocessableEntity'
1531 $ref: '#/components/responses/InternalServerError'
1533 $ref: '#/components/responses/ServiceUnavailable'
1535 $ref: '#/components/responses/UnexpectedError'
1537 $ref: '#/components/responses/UnexpectedError'
1538 '/nslcm/v1/ns_instances/{nsInstanceId}/scale':
1540 - name: nsInstanceId
1543 description: NS Instance ID
1549 summary: Scale a NS instance
1551 Scale a NS instance. The precondition is that the NS instance must have
1552 been created and must be in INSTANTIATED state. As a result of the
1553 success of this operation, the NFVO creates a "NS Lifecycle Operation
1554 Occurrence" resource for the request, and the NS instance state remains
1556 operationId: scaleNSinstance
1558 $ref: '#/components/requestBodies/ScaleNsRequest'
1561 description: Accepted
1565 It must point to the new "NS Lifecycle Operation Occurrence"
1566 resource, i.e. an URI like ".../ns_lcm_op_occs/{nsLcmOpOccId}"
1571 $ref: '#/components/responses/BadRequest'
1573 $ref: '#/components/responses/Unauthorized'
1575 $ref: '#/components/responses/Forbidden'
1577 $ref: '#/components/responses/NotFound'
1579 $ref: '#/components/responses/MethodNotAllowed'
1581 $ref: '#/components/responses/NotAcceptable'
1583 $ref: '#/components/responses/Conflict'
1585 $ref: '#/components/responses/UnprocessableEntity'
1587 $ref: '#/components/responses/InternalServerError'
1589 $ref: '#/components/responses/ServiceUnavailable'
1591 $ref: '#/components/responses/UnexpectedError'
1593 $ref: '#/components/responses/UnexpectedError'
1594 '/nslcm/v1/ns_instances/{nsInstanceId}/terminate':
1596 - name: nsInstanceId
1599 description: NS Instance ID
1605 summary: Terminate a NS instance
1607 Terminate a NS instance. The precondition is that the NS instance must have
1608 been created and must be in INSTANTIATED state. As a result of the
1609 success of this operation, the NFVO creates a "NS Lifecycle Operation
1610 Occurrence" resource for the request, and the NS instance state becomes
1612 operationId: terminateNSinstance
1614 # Request data is not required
1615 $ref: '#/components/requestBodies/TerminateNsRequest'
1618 description: Accepted
1622 It must point to the new "NS Lifecycle Operation Occurrence"
1623 resource, i.e. an URI like ".../ns_lcm_op_occs/{nsLcmOpOccId}"
1630 $ref: '#/components/schemas/ObjectId'
1633 $ref: '#/components/schemas/ObjectId'
1635 $ref: '#/components/responses/BadRequest'
1637 $ref: '#/components/responses/Unauthorized'
1639 $ref: '#/components/responses/Forbidden'
1641 $ref: '#/components/responses/NotFound'
1643 $ref: '#/components/responses/MethodNotAllowed'
1645 $ref: '#/components/responses/NotAcceptable'
1647 $ref: '#/components/responses/Conflict'
1649 $ref: '#/components/responses/UnprocessableEntity'
1651 $ref: '#/components/responses/InternalServerError'
1653 $ref: '#/components/responses/ServiceUnavailable'
1655 $ref: '#/components/responses/UnexpectedError'
1657 $ref: '#/components/responses/UnexpectedError'
1658 '/nslcm/v1/ns_instances/{nsInstanceId}/action':
1660 - name: nsInstanceId
1663 description: NS Instance ID
1669 summary: Execute an action on a NS instance
1671 Execute an action on a NS instance.
1672 The NS instance must have been created and must be in INSTANTIATED state.
1673 operationId: actionOnNSinstance
1678 $ref: '#/components/schemas/NSinstanceActionRequest'
1681 $ref: '#/components/schemas/NSinstanceActionRequest'
1684 description: Accepted
1688 It must point to the new "NS Lifecycle Operation Occurrence"
1689 resource, i.e. an URI like ".../ns_lcm_op_occs/{nsLcmOpOccId}"
1696 $ref: '#/components/schemas/ObjectId'
1699 $ref: '#/components/schemas/ObjectId'
1701 $ref: '#/components/responses/BadRequest'
1703 $ref: '#/components/responses/Unauthorized'
1705 $ref: '#/components/responses/Forbidden'
1707 $ref: '#/components/responses/NotFound'
1709 $ref: '#/components/responses/MethodNotAllowed'
1711 $ref: '#/components/responses/NotAcceptable'
1713 $ref: '#/components/responses/Conflict'
1715 $ref: '#/components/responses/UnprocessableEntity'
1717 $ref: '#/components/responses/InternalServerError'
1719 $ref: '#/components/responses/ServiceUnavailable'
1721 $ref: '#/components/responses/UnexpectedError'
1723 $ref: '#/components/responses/UnexpectedError'
1724 '/nslcm/v1/ns_instances_content':
1728 summary: Query information about multiple NS instances
1729 description: Query information about multiple NS isntances
1730 operationId: getNSinstancesContent
1737 $ref: '#/components/schemas/ArrayOfNsInstance'
1740 $ref: '#/components/schemas/ArrayOfNsInstance'
1742 $ref: '#/components/responses/BadRequest'
1744 $ref: '#/components/responses/Unauthorized'
1746 $ref: '#/components/responses/Forbidden'
1748 $ref: '#/components/responses/NotFound'
1750 $ref: '#/components/responses/MethodNotAllowed'
1752 $ref: '#/components/responses/NotAcceptable'
1754 $ref: '#/components/responses/Conflict'
1756 $ref: '#/components/responses/UnprocessableEntity'
1758 $ref: '#/components/responses/InternalServerError'
1760 $ref: '#/components/responses/ServiceUnavailable'
1762 $ref: '#/components/responses/UnexpectedError'
1764 $ref: '#/components/responses/UnexpectedError'
1768 summary: Create a new NS instance
1769 description: Create a new NS instance
1770 operationId: createNSinstanceContent
1772 $ref: '#/components/requestBodies/InstantiateNsRequest'
1775 description: Created
1784 $ref: '#/components/schemas/CreateNSinstanceContentResponse'
1787 $ref: '#/components/schemas/CreateNSinstanceContentResponse'
1789 $ref: '#/components/responses/BadRequest'
1791 $ref: '#/components/responses/Unauthorized'
1793 $ref: '#/components/responses/Forbidden'
1795 $ref: '#/components/responses/NotFound'
1797 $ref: '#/components/responses/MethodNotAllowed'
1799 $ref: '#/components/responses/NotAcceptable'
1801 $ref: '#/components/responses/Conflict'
1803 $ref: '#/components/responses/UnprocessableEntity'
1805 $ref: '#/components/responses/InternalServerError'
1807 $ref: '#/components/responses/ServiceUnavailable'
1809 $ref: '#/components/responses/UnexpectedError'
1811 $ref: '#/components/responses/UnexpectedError'
1812 '/nslcm/v1/ns_instances_content/{nsInstanceContentId}':
1814 - name: nsInstanceContentId
1817 description: NS Instance Content ID
1823 summary: Read an individual NS instance resource
1824 description: Read an individual NS instance resource
1825 operationId: getNSinstanceContent
1832 $ref: '#/components/schemas/NsInstance'
1835 $ref: '#/components/schemas/NsInstance'
1837 $ref: '#/components/responses/BadRequest'
1839 $ref: '#/components/responses/Unauthorized'
1841 $ref: '#/components/responses/Forbidden'
1843 $ref: '#/components/responses/NotFound'
1845 $ref: '#/components/responses/MethodNotAllowed'
1847 $ref: '#/components/responses/NotAcceptable'
1849 $ref: '#/components/responses/Conflict'
1851 $ref: '#/components/responses/UnprocessableEntity'
1853 $ref: '#/components/responses/InternalServerError'
1855 $ref: '#/components/responses/ServiceUnavailable'
1857 $ref: '#/components/responses/UnexpectedError'
1859 $ref: '#/components/responses/UnexpectedError'
1863 summary: Delete an individual NS instance resource
1864 description: Delete an individual NS instance resource
1865 operationId: deleteNSinstanceContent
1868 description: Accepted
1872 $ref: '#/components/schemas/ObjectId'
1875 $ref: '#/components/schemas/ObjectId'
1877 description: No Content
1879 $ref: '#/components/responses/BadRequest'
1881 $ref: '#/components/responses/Unauthorized'
1883 $ref: '#/components/responses/Forbidden'
1885 $ref: '#/components/responses/NotFound'
1887 $ref: '#/components/responses/MethodNotAllowed'
1889 $ref: '#/components/responses/NotAcceptable'
1891 $ref: '#/components/responses/Conflict'
1893 $ref: '#/components/responses/UnprocessableEntity'
1895 $ref: '#/components/responses/InternalServerError'
1897 $ref: '#/components/responses/ServiceUnavailable'
1899 $ref: '#/components/responses/UnexpectedError'
1901 $ref: '#/components/responses/UnexpectedError'
1902 '/nslcm/v1/ns_lcm_op_occs':
1906 summary: Query information about multiple NS LCM Operation Occurrences
1907 description: Query information about multiple NS LCM Operation Occurrences
1908 operationId: getNSLCMOpOccs
1915 $ref: '#/components/schemas/ArrayOfNsLcmOpOcc'
1918 $ref: '#/components/schemas/ArrayOfNsLcmOpOcc'
1920 $ref: '#/components/responses/BadRequest'
1922 $ref: '#/components/responses/Unauthorized'
1924 $ref: '#/components/responses/Forbidden'
1926 $ref: '#/components/responses/NotFound'
1928 $ref: '#/components/responses/MethodNotAllowed'
1930 $ref: '#/components/responses/NotAcceptable'
1932 $ref: '#/components/responses/Conflict'
1934 $ref: '#/components/responses/UnprocessableEntity'
1936 $ref: '#/components/responses/InternalServerError'
1938 $ref: '#/components/responses/ServiceUnavailable'
1940 $ref: '#/components/responses/UnexpectedError'
1942 $ref: '#/components/responses/UnexpectedError'
1943 '/nslcm/v1/ns_lcm_op_occs/{nsLcmOpOccId}':
1945 - name: nsLcmOpOccId
1948 description: NS LCM Operation Occurrence ID
1954 summary: Query information about an individual NS LCM Operation Occurrence
1955 description: Query information about an individual NS LCM Operation Occurrence
1956 operationId: getNSLCMOpOcc
1963 $ref: '#/components/schemas/NsLcmOpOcc'
1966 $ref: '#/components/schemas/NsLcmOpOcc'
1968 $ref: '#/components/responses/BadRequest'
1970 $ref: '#/components/responses/Unauthorized'
1972 $ref: '#/components/responses/Forbidden'
1974 $ref: '#/components/responses/NotFound'
1976 $ref: '#/components/responses/MethodNotAllowed'
1978 $ref: '#/components/responses/NotAcceptable'
1980 $ref: '#/components/responses/Conflict'
1982 $ref: '#/components/responses/UnprocessableEntity'
1984 $ref: '#/components/responses/InternalServerError'
1986 $ref: '#/components/responses/ServiceUnavailable'
1988 $ref: '#/components/responses/UnexpectedError'
1990 $ref: '#/components/responses/UnexpectedError'
1991 '/nslcm/v1/vnf_instances':
1995 summary: Query information about multiple VNF Instances
1996 description: Query information about multiple VNF Instances
1997 operationId: getVnfInstances
2004 $ref: '#/components/schemas/ArrayOfVnfInstanceInfo'
2007 $ref: '#/components/schemas/ArrayOfVnfInstanceInfo'
2009 $ref: '#/components/responses/BadRequest'
2011 $ref: '#/components/responses/Unauthorized'
2013 $ref: '#/components/responses/Forbidden'
2015 $ref: '#/components/responses/NotFound'
2017 $ref: '#/components/responses/MethodNotAllowed'
2019 $ref: '#/components/responses/NotAcceptable'
2021 $ref: '#/components/responses/Conflict'
2023 $ref: '#/components/responses/UnprocessableEntity'
2025 $ref: '#/components/responses/InternalServerError'
2027 $ref: '#/components/responses/ServiceUnavailable'
2029 $ref: '#/components/responses/UnexpectedError'
2031 $ref: '#/components/responses/UnexpectedError'
2032 '/nslcm/v1/vnf_instances/{vnfInstanceId}':
2034 - name: vnfInstanceId
2037 description: VNF Instance ID
2043 summary: Query information about an individual VNF Instance
2044 description: Query information about an individual VNF Instance
2045 operationId: getVnfInstance
2052 $ref: '#/components/schemas/VnfInstanceInfo'
2055 $ref: '#/components/schemas/VnfInstanceInfo'
2057 $ref: '#/components/responses/BadRequest'
2059 $ref: '#/components/responses/Unauthorized'
2061 $ref: '#/components/responses/Forbidden'
2063 $ref: '#/components/responses/NotFound'
2065 $ref: '#/components/responses/MethodNotAllowed'
2067 $ref: '#/components/responses/NotAcceptable'
2069 $ref: '#/components/responses/Conflict'
2071 $ref: '#/components/responses/UnprocessableEntity'
2073 $ref: '#/components/responses/InternalServerError'
2075 $ref: '#/components/responses/ServiceUnavailable'
2077 $ref: '#/components/responses/UnexpectedError'
2079 $ref: '#/components/responses/UnexpectedError'
2082 # BEGIN NetSlice Templates
2083 '/nst/v1/netslice_templates':
2086 - "NetSlice templates"
2087 summary: Query information about multiple NetSlice template resources
2088 description: Query information about multiple NetSlice template resources
2089 operationId: getNSTs
2096 $ref: '#/components/schemas/ArrayOfNstInfo'
2099 $ref: '#/components/schemas/ArrayOfNstInfo'
2101 $ref: '#/components/responses/BadRequest'
2103 $ref: '#/components/responses/Unauthorized'
2105 $ref: '#/components/responses/Forbidden'
2107 $ref: '#/components/responses/NotFound'
2109 $ref: '#/components/responses/MethodNotAllowed'
2111 $ref: '#/components/responses/NotAcceptable'
2113 $ref: '#/components/responses/Conflict'
2115 $ref: '#/components/responses/UnprocessableEntity'
2117 $ref: '#/components/responses/InternalServerError'
2119 $ref: '#/components/responses/ServiceUnavailable'
2121 $ref: '#/components/responses/UnexpectedError'
2123 $ref: '#/components/responses/UnexpectedError'
2126 - "NetSlice templates"
2127 summary: Create a new NetSlice template resource
2128 description: Create a new NetSlice template resource
2131 $ref: '#/components/requestBodies/CreateNstInfoRequest'
2134 description: Created
2143 $ref: '#/components/schemas/ObjectId'
2146 $ref: '#/components/schemas/ObjectId'
2148 $ref: '#/components/responses/BadRequest'
2150 $ref: '#/components/responses/Unauthorized'
2152 $ref: '#/components/responses/Forbidden'
2154 $ref: '#/components/responses/NotFound'
2156 $ref: '#/components/responses/MethodNotAllowed'
2158 $ref: '#/components/responses/NotAcceptable'
2160 $ref: '#/components/responses/Conflict'
2162 $ref: '#/components/responses/UnprocessableEntity'
2164 $ref: '#/components/responses/InternalServerError'
2166 $ref: '#/components/responses/ServiceUnavailable'
2168 $ref: '#/components/responses/UnexpectedError'
2170 $ref: '#/components/responses/UnexpectedError'
2171 '/nst/v1/netslice_templates/{netsliceTemplateId}':
2173 - name: netsliceTemplateId
2176 description: NetSlice Template ID
2181 - "NetSlice templates"
2182 summary: Read information about an individual NetSlice template resource
2183 description: Read information about an individual NetSlice template resource
2191 $ref: '#/components/schemas/NstInfo'
2194 $ref: '#/components/schemas/NstInfo'
2196 $ref: '#/components/responses/BadRequest'
2198 $ref: '#/components/responses/Unauthorized'
2200 $ref: '#/components/responses/Forbidden'
2202 $ref: '#/components/responses/NotFound'
2204 $ref: '#/components/responses/MethodNotAllowed'
2206 $ref: '#/components/responses/NotAcceptable'
2208 $ref: '#/components/responses/Conflict'
2210 $ref: '#/components/responses/UnprocessableEntity'
2212 $ref: '#/components/responses/InternalServerError'
2214 $ref: '#/components/responses/ServiceUnavailable'
2216 $ref: '#/components/responses/UnexpectedError'
2218 $ref: '#/components/responses/UnexpectedError'
2221 - "NetSlice templates"
2222 summary: Delete an individual NetSlice template resource
2223 description: Delete an individual NetSlice template resource
2224 operationId: deleteNST
2227 description: No Content
2229 $ref: '#/components/responses/BadRequest'
2231 $ref: '#/components/responses/Unauthorized'
2233 $ref: '#/components/responses/Forbidden'
2235 $ref: '#/components/responses/NotFound'
2237 $ref: '#/components/responses/MethodNotAllowed'
2239 $ref: '#/components/responses/NotAcceptable'
2241 $ref: '#/components/responses/Conflict'
2243 $ref: '#/components/responses/UnprocessableEntity'
2245 $ref: '#/components/responses/InternalServerError'
2247 $ref: '#/components/responses/ServiceUnavailable'
2249 $ref: '#/components/responses/UnexpectedError'
2251 $ref: '#/components/responses/UnexpectedError'
2252 '/nst/v1/netslice_templates/{netsliceTemplateId}/artifacts/{artifactPath}':
2254 - name: netsliceTemplateId
2257 description: NetSlice Template ID
2260 - name: artifactPath
2263 description: Artifact Path
2268 - "NetSlice templates"
2269 summary: Fetch individual NetSlice Template artifact
2270 description: Fetch individual NetSlice Template artifact
2271 operationId: getNstArtifact
2276 application/octet-stream:
2281 description: Partial Content
2287 application/octet-stream:
2292 $ref: '#/components/responses/BadRequest'
2294 $ref: '#/components/responses/Unauthorized'
2296 $ref: '#/components/responses/Forbidden'
2298 $ref: '#/components/responses/NotFound'
2300 $ref: '#/components/responses/MethodNotAllowed'
2302 $ref: '#/components/responses/NotAcceptable'
2304 $ref: '#/components/responses/Conflict'
2306 $ref: '#/components/responses/UnprocessableEntity'
2308 $ref: '#/components/responses/InternalServerError'
2310 $ref: '#/components/responses/ServiceUnavailable'
2312 $ref: '#/components/responses/UnexpectedError'
2314 $ref: '#/components/responses/UnexpectedError'
2315 '/nst/v1/netslice_templates/{netsliceTemplateId}/nst':
2317 - name: netsliceTemplateId
2320 description: NetSlice Template ID
2325 - "NetSlice templates"
2326 summary: Read NST of an on-boarded NetSlice Template
2327 description: Read NST of an on-boarded NetSlice Template
2328 operationId: getNstNst
2335 $ref: '#/components/schemas/NetSliceTemplate'
2337 $ref: '#/components/responses/BadRequest'
2339 $ref: '#/components/responses/Unauthorized'
2341 $ref: '#/components/responses/Forbidden'
2343 $ref: '#/components/responses/NotFound'
2345 $ref: '#/components/responses/MethodNotAllowed'
2347 $ref: '#/components/responses/NotAcceptable'
2349 $ref: '#/components/responses/Conflict'
2351 $ref: '#/components/responses/UnprocessableEntity'
2353 $ref: '#/components/responses/InternalServerError'
2355 $ref: '#/components/responses/ServiceUnavailable'
2357 $ref: '#/components/responses/UnexpectedError'
2359 $ref: '#/components/responses/UnexpectedError'
2360 '/nst/v1/netslice_templates/{netsliceTemplateId}/nst_content':
2362 - name: netsliceTemplateId
2365 description: NetSlice Template ID
2370 - "NetSlice templates"
2371 summary: Fetch the content of a NST
2372 description: Fetch the content of a NST
2373 operationId: getNSTcontent
2380 $ref: '#/components/schemas/NetSlicePackage'
2382 description: Partial Content
2390 $ref: '#/components/schemas/NetSlicePackage'
2392 $ref: '#/components/responses/BadRequest'
2394 $ref: '#/components/responses/Unauthorized'
2396 $ref: '#/components/responses/Forbidden'
2398 $ref: '#/components/responses/NotFound'
2400 $ref: '#/components/responses/MethodNotAllowed'
2402 $ref: '#/components/responses/NotAcceptable'
2404 $ref: '#/components/responses/Conflict'
2406 $ref: '#/components/responses/UnprocessableEntity'
2408 $ref: '#/components/responses/InternalServerError'
2410 $ref: '#/components/responses/ServiceUnavailable'
2412 $ref: '#/components/responses/UnexpectedError'
2414 $ref: '#/components/responses/UnexpectedError'
2417 - "NetSlice templates"
2418 summary: Upload the content of a NST
2419 description: Upload the content of a NST
2420 operationId: updateNSTcontent
2422 $ref: '#/components/requestBodies/NetSlicePackage'
2425 description: Accepted
2427 description: No Content
2429 $ref: '#/components/responses/BadRequest'
2431 $ref: '#/components/responses/Unauthorized'
2433 $ref: '#/components/responses/Forbidden'
2435 $ref: '#/components/responses/NotFound'
2437 $ref: '#/components/responses/MethodNotAllowed'
2439 $ref: '#/components/responses/NotAcceptable'
2441 $ref: '#/components/responses/Conflict'
2443 $ref: '#/components/responses/UnprocessableEntity'
2445 $ref: '#/components/responses/InternalServerError'
2447 $ref: '#/components/responses/ServiceUnavailable'
2449 $ref: '#/components/responses/UnexpectedError'
2451 $ref: '#/components/responses/UnexpectedError'
2452 '/nst/v1/netslice_templates_content':
2455 - "NetSlice templates"
2456 summary: Upload a NetSlice package by providing the content of the NetSlice package
2457 description: Upload a NetSlice package by providing the content of the NetSlice package
2458 operationId: uploadNstContent
2463 $ref: '#/components/schemas/NetSlicePackage'
2466 description: Created
2475 $ref: '#/components/schemas/ObjectId'
2478 $ref: '#/components/schemas/ObjectId'
2480 description: Accepted
2482 description: No Content
2484 $ref: '#/components/responses/BadRequest'
2486 $ref: '#/components/responses/Unauthorized'
2488 $ref: '#/components/responses/Forbidden'
2490 $ref: '#/components/responses/NotFound'
2492 $ref: '#/components/responses/MethodNotAllowed'
2494 $ref: '#/components/responses/NotAcceptable'
2496 $ref: '#/components/responses/Conflict'
2498 $ref: '#/components/responses/UnprocessableEntity'
2500 $ref: '#/components/responses/InternalServerError'
2502 $ref: '#/components/responses/ServiceUnavailable'
2504 $ref: '#/components/responses/UnexpectedError'
2506 $ref: '#/components/responses/UnexpectedError'
2509 - "NetSlice templates"
2510 summary: Query information about multiple NetSlice Template resources
2511 description: Query information about multiple NetSlice Template resources
2512 operationId: getNstContent
2519 $ref: '#/components/schemas/ArrayOfNstInfo'
2522 $ref: '#/components/schemas/ArrayOfNstInfo'
2524 description: Partial Content
2530 application/octet-stream:
2535 $ref: '#/components/responses/BadRequest'
2537 $ref: '#/components/responses/Unauthorized'
2539 $ref: '#/components/responses/Forbidden'
2541 $ref: '#/components/responses/NotFound'
2543 $ref: '#/components/responses/MethodNotAllowed'
2545 $ref: '#/components/responses/NotAcceptable'
2547 $ref: '#/components/responses/Conflict'
2549 $ref: '#/components/responses/UnprocessableEntity'
2551 $ref: '#/components/responses/InternalServerError'
2553 $ref: '#/components/responses/ServiceUnavailable'
2555 $ref: '#/components/responses/UnexpectedError'
2557 $ref: '#/components/responses/UnexpectedError'
2558 '/nst/v1/netslice_templates_content/{netsliceTemplateContentId}':
2560 - name: netsliceTemplateContentId
2563 description: NetSlice Template ID
2568 - "NetSlice templates"
2569 summary: Read information about an individual NetSlice Template resource
2570 description: Read information about an individual NetSlice Template resource
2571 operationId: getNstIdContent
2578 $ref: '#/components/schemas/NstInfo'
2581 $ref: '#/components/schemas/NstInfo'
2583 $ref: '#/components/responses/BadRequest'
2585 $ref: '#/components/responses/Unauthorized'
2587 $ref: '#/components/responses/Forbidden'
2589 $ref: '#/components/responses/NotFound'
2591 $ref: '#/components/responses/MethodNotAllowed'
2593 $ref: '#/components/responses/NotAcceptable'
2595 $ref: '#/components/responses/Conflict'
2597 $ref: '#/components/responses/UnprocessableEntity'
2599 $ref: '#/components/responses/InternalServerError'
2601 $ref: '#/components/responses/ServiceUnavailable'
2603 $ref: '#/components/responses/UnexpectedError'
2605 $ref: '#/components/responses/UnexpectedError'
2608 - "NetSlice templates"
2609 summary: Modify an individual NetSlice Template resource
2610 description: Modify an individual NetSlice Template resource
2611 operationId: updateNstIdContent
2613 $ref: '#/components/requestBodies/NstInfoModifications'
2616 description: No Content
2618 $ref: '#/components/responses/BadRequest'
2620 $ref: '#/components/responses/Unauthorized'
2622 $ref: '#/components/responses/Forbidden'
2624 $ref: '#/components/responses/NotFound'
2626 $ref: '#/components/responses/MethodNotAllowed'
2628 $ref: '#/components/responses/NotAcceptable'
2630 $ref: '#/components/responses/Conflict'
2632 $ref: '#/components/responses/UnprocessableEntity'
2634 $ref: '#/components/responses/InternalServerError'
2636 $ref: '#/components/responses/ServiceUnavailable'
2638 $ref: '#/components/responses/UnexpectedError'
2640 $ref: '#/components/responses/UnexpectedError'
2643 - "NetSlice templates"
2644 summary: Delete an individual NetSlice Template resource
2645 description: Delete an individual NetSlice Template resource
2646 operationId: deleteNstIdContent
2649 description: No Content
2651 $ref: '#/components/responses/BadRequest'
2653 $ref: '#/components/responses/Unauthorized'
2655 $ref: '#/components/responses/Forbidden'
2657 $ref: '#/components/responses/NotFound'
2659 $ref: '#/components/responses/MethodNotAllowed'
2661 $ref: '#/components/responses/NotAcceptable'
2663 $ref: '#/components/responses/Conflict'
2665 $ref: '#/components/responses/UnprocessableEntity'
2667 $ref: '#/components/responses/InternalServerError'
2669 $ref: '#/components/responses/ServiceUnavailable'
2671 $ref: '#/components/responses/UnexpectedError'
2673 $ref: '#/components/responses/UnexpectedError'
2674 # END NetSlice Templates
2676 # BEGIN NetSlice Instances
2677 '/nsilcm/v1/netslice_instances':
2680 - "NetSlice instances"
2681 summary: Query information about multiple NetSlice instances
2682 description: Query information about multiple NetSlice isntances
2683 operationId: getNSIs
2690 $ref: '#/components/schemas/ArrayOfNetSliceInstance'
2693 $ref: '#/components/schemas/ArrayOfNetSliceInstance'
2695 $ref: '#/components/responses/BadRequest'
2697 $ref: '#/components/responses/Unauthorized'
2699 $ref: '#/components/responses/Forbidden'
2701 $ref: '#/components/responses/NotFound'
2703 $ref: '#/components/responses/MethodNotAllowed'
2705 $ref: '#/components/responses/NotAcceptable'
2707 $ref: '#/components/responses/Conflict'
2709 $ref: '#/components/responses/UnprocessableEntity'
2711 $ref: '#/components/responses/InternalServerError'
2713 $ref: '#/components/responses/ServiceUnavailable'
2715 $ref: '#/components/responses/UnexpectedError'
2717 $ref: '#/components/responses/UnexpectedError'
2720 - "NetSlice instances"
2721 summary: Create a new NetSlice instance resource
2722 description: Create a new NetSlice instance resource
2725 $ref: '#/components/requestBodies/InstantiateNsiRequest'
2728 description: Created
2737 $ref: '#/components/schemas/ObjectId'
2740 $ref: '#/components/schemas/ObjectId'
2742 $ref: '#/components/responses/BadRequest'
2744 $ref: '#/components/responses/Unauthorized'
2746 $ref: '#/components/responses/Forbidden'
2748 $ref: '#/components/responses/NotFound'
2750 $ref: '#/components/responses/MethodNotAllowed'
2752 $ref: '#/components/responses/NotAcceptable'
2754 $ref: '#/components/responses/Conflict'
2756 $ref: '#/components/responses/UnprocessableEntity'
2758 $ref: '#/components/responses/InternalServerError'
2760 $ref: '#/components/responses/ServiceUnavailable'
2762 $ref: '#/components/responses/UnexpectedError'
2764 $ref: '#/components/responses/UnexpectedError'
2765 '/nsilcm/v1/netslice_instances/{netsliceInstanceId}':
2767 - name: netsliceInstanceId
2770 description: NetSlice Instance ID
2775 - "NetSlice instances"
2776 summary: Read an individual NetSlice instance resource
2777 description: Read an individual NetSlice instance resource
2785 $ref: '#/components/schemas/NetSliceInstance'
2788 $ref: '#/components/schemas/NetSliceInstance'
2790 $ref: '#/components/responses/BadRequest'
2792 $ref: '#/components/responses/Unauthorized'
2794 $ref: '#/components/responses/Forbidden'
2796 $ref: '#/components/responses/NotFound'
2798 $ref: '#/components/responses/MethodNotAllowed'
2800 $ref: '#/components/responses/NotAcceptable'
2802 $ref: '#/components/responses/Conflict'
2804 $ref: '#/components/responses/UnprocessableEntity'
2806 $ref: '#/components/responses/InternalServerError'
2808 $ref: '#/components/responses/ServiceUnavailable'
2810 $ref: '#/components/responses/UnexpectedError'
2812 $ref: '#/components/responses/UnexpectedError'
2815 - "NetSlice instances"
2816 summary: Delete an individual NetSlice instance resource
2817 description: Delete an individual NetSlice instance resource
2818 operationId: deleteNSI
2821 description: No Content
2823 $ref: '#/components/responses/BadRequest'
2825 $ref: '#/components/responses/Unauthorized'
2827 $ref: '#/components/responses/Forbidden'
2829 $ref: '#/components/responses/NotFound'
2831 $ref: '#/components/responses/MethodNotAllowed'
2833 $ref: '#/components/responses/NotAcceptable'
2835 $ref: '#/components/responses/Conflict'
2837 $ref: '#/components/responses/UnprocessableEntity'
2839 $ref: '#/components/responses/InternalServerError'
2841 $ref: '#/components/responses/ServiceUnavailable'
2843 $ref: '#/components/responses/UnexpectedError'
2845 $ref: '#/components/responses/UnexpectedError'
2846 '/nsilcm/v1/netslice_instances/{netsliceInstanceId}/instantiate':
2848 - name: netsliceInstanceId
2851 description: NetSlice Instance ID
2856 - "NetSlice instances"
2857 summary: Instantiate a NetSlice
2859 Instantiate a NetSlice. The precondition is that the NetSlice instance
2860 must have been created and must be in NOT_INSTANTIATED state. As a result
2861 of the success of this operation, the NFVO creates a "NetSlice Lifecycle
2862 Operation Occurrence" resource for the request, and the NS instance state
2863 becomes INSTANTIATED.
2864 operationId: instantiateNSI
2866 $ref: '#/components/requestBodies/InstantiateNsiRequest'
2869 description: Accepted
2873 It must point to the new "NetSlice Lifecycle Operation Occurrence"
2874 resource, i.e. an URI like ".../nsi_lcm_op_occs/{nsiLcmOpOccId}"
2881 $ref: '#/components/schemas/ObjectId'
2884 $ref: '#/components/schemas/ObjectId'
2886 $ref: '#/components/responses/BadRequest'
2888 $ref: '#/components/responses/Unauthorized'
2890 $ref: '#/components/responses/Forbidden'
2892 $ref: '#/components/responses/NotFound'
2894 $ref: '#/components/responses/MethodNotAllowed'
2896 $ref: '#/components/responses/NotAcceptable'
2898 $ref: '#/components/responses/Conflict'
2900 $ref: '#/components/responses/UnprocessableEntity'
2902 $ref: '#/components/responses/InternalServerError'
2904 $ref: '#/components/responses/ServiceUnavailable'
2906 $ref: '#/components/responses/UnexpectedError'
2908 $ref: '#/components/responses/UnexpectedError'
2909 '/nsilcm/v1/netslice_instances/{netsliceInstanceId}/terminate':
2911 - name: netsliceInstanceId
2914 description: NetSlice Instance ID
2919 - "NetSlice instances"
2920 summary: Terminate a NetSlice instance
2922 Terminate a NetSlice instance. The precondition is that the NetSlice instance
2923 must have been created and must be in INSTANTIATED state. As a result of the
2924 success of this operation, the NFVO creates a "NetSlice Lifecycle Operation
2925 Occurrence" resource for the request, and the NetSlice instance state becomes
2927 operationId: terminateNSI
2929 # Request data is not required
2930 $ref: '#/components/requestBodies/TerminateNsiRequest'
2933 description: Accepted
2937 It must point to the new "NetSlice Lifecycle Operation Occurrence"
2938 resource, i.e. an URI like ".../nsi_lcm_op_occs/{nsiLcmOpOccId}"
2945 $ref: '#/components/schemas/ObjectId'
2948 $ref: '#/components/schemas/ObjectId'
2950 $ref: '#/components/responses/BadRequest'
2952 $ref: '#/components/responses/Unauthorized'
2954 $ref: '#/components/responses/Forbidden'
2956 $ref: '#/components/responses/NotFound'
2958 $ref: '#/components/responses/MethodNotAllowed'
2960 $ref: '#/components/responses/NotAcceptable'
2962 $ref: '#/components/responses/Conflict'
2964 $ref: '#/components/responses/UnprocessableEntity'
2966 $ref: '#/components/responses/InternalServerError'
2968 $ref: '#/components/responses/ServiceUnavailable'
2970 $ref: '#/components/responses/UnexpectedError'
2972 $ref: '#/components/responses/UnexpectedError'
2973 '/nsilcm/v1/netslice_instances/{netsliceInstanceId}/action':
2975 - name: netsliceInstanceId
2978 description: NetSlice Instance ID
2983 - "NetSlice instances"
2984 summary: Execute an action on a NetSlice instance
2986 Execute an action on a NetSlice instance.
2987 The NetSlice instance must have been created and must be in INSTANTIATED state.
2988 operationId: actionOnNSI
2993 $ref: '#/components/schemas/NsiActionRequest'
2996 $ref: '#/components/schemas/NsiActionRequest'
2999 description: Accepted
3003 It must point to the new "NS Lifecycle Operation Occurrence"
3004 resource, i.e. an URI like ".../ns_lcm_op_occs/{nsLcmOpOccId}"
3011 $ref: '#/components/schemas/ObjectId'
3014 $ref: '#/components/schemas/ObjectId'
3016 $ref: '#/components/responses/BadRequest'
3018 $ref: '#/components/responses/Unauthorized'
3020 $ref: '#/components/responses/Forbidden'
3022 $ref: '#/components/responses/NotFound'
3024 $ref: '#/components/responses/MethodNotAllowed'
3026 $ref: '#/components/responses/NotAcceptable'
3028 $ref: '#/components/responses/Conflict'
3030 $ref: '#/components/responses/UnprocessableEntity'
3032 $ref: '#/components/responses/InternalServerError'
3034 $ref: '#/components/responses/ServiceUnavailable'
3036 $ref: '#/components/responses/UnexpectedError'
3038 $ref: '#/components/responses/UnexpectedError'
3039 '/nsilcm/v1/netslice_instances_content':
3042 - "NetSlice instances"
3043 summary: Query information about multiple NetSlice instances
3044 description: Query information about multiple NetSlice isntances
3045 operationId: getNSIsContent
3052 $ref: '#/components/schemas/ArrayOfNetSliceInstance'
3055 $ref: '#/components/schemas/ArrayOfNetSliceInstance'
3057 $ref: '#/components/responses/BadRequest'
3059 $ref: '#/components/responses/Unauthorized'
3061 $ref: '#/components/responses/Forbidden'
3063 $ref: '#/components/responses/NotFound'
3065 $ref: '#/components/responses/MethodNotAllowed'
3067 $ref: '#/components/responses/NotAcceptable'
3069 $ref: '#/components/responses/Conflict'
3071 $ref: '#/components/responses/UnprocessableEntity'
3073 $ref: '#/components/responses/InternalServerError'
3075 $ref: '#/components/responses/ServiceUnavailable'
3077 $ref: '#/components/responses/UnexpectedError'
3079 $ref: '#/components/responses/UnexpectedError'
3082 - "NetSlice instances"
3083 summary: Create a new NetSlice instance
3084 description: Create a new NetSlice instance
3085 operationId: createNSIContent
3087 $ref: '#/components/requestBodies/InstantiateNsiRequest'
3090 description: Created
3099 $ref: '#/components/schemas/CreateNsiContentResponse'
3102 $ref: '#/components/schemas/CreateNsiContentResponse'
3104 $ref: '#/components/responses/BadRequest'
3106 $ref: '#/components/responses/Unauthorized'
3108 $ref: '#/components/responses/Forbidden'
3110 $ref: '#/components/responses/NotFound'
3112 $ref: '#/components/responses/MethodNotAllowed'
3114 $ref: '#/components/responses/NotAcceptable'
3116 $ref: '#/components/responses/Conflict'
3118 $ref: '#/components/responses/UnprocessableEntity'
3120 $ref: '#/components/responses/InternalServerError'
3122 $ref: '#/components/responses/ServiceUnavailable'
3124 $ref: '#/components/responses/UnexpectedError'
3126 $ref: '#/components/responses/UnexpectedError'
3127 '/nsilcm/v1/netslice_instances_content/{netsliceInstanceContentId}':
3129 - name: netsliceInstanceContentId
3132 description: NetSlice Instance Content ID
3137 - "NetSlice instances"
3138 summary: Read an individual NetSlice instance resource
3139 description: Read an individual NetSlice instance resource
3140 operationId: getNSIContent
3147 $ref: '#/components/schemas/NetSliceInstance'
3150 $ref: '#/components/schemas/NetSliceInstance'
3152 $ref: '#/components/responses/BadRequest'
3154 $ref: '#/components/responses/Unauthorized'
3156 $ref: '#/components/responses/Forbidden'
3158 $ref: '#/components/responses/NotFound'
3160 $ref: '#/components/responses/MethodNotAllowed'
3162 $ref: '#/components/responses/NotAcceptable'
3164 $ref: '#/components/responses/Conflict'
3166 $ref: '#/components/responses/UnprocessableEntity'
3168 $ref: '#/components/responses/InternalServerError'
3170 $ref: '#/components/responses/ServiceUnavailable'
3172 $ref: '#/components/responses/UnexpectedError'
3174 $ref: '#/components/responses/UnexpectedError'
3177 - "NetSlice instances"
3178 summary: Delete an individual NS instance resource
3179 description: Delete an individual NS instance resource
3180 operationId: deleteNSIContent
3183 description: Accepted
3187 $ref: '#/components/schemas/ObjectId'
3190 $ref: '#/components/schemas/ObjectId'
3192 description: No Content
3194 $ref: '#/components/responses/BadRequest'
3196 $ref: '#/components/responses/Unauthorized'
3198 $ref: '#/components/responses/Forbidden'
3200 $ref: '#/components/responses/NotFound'
3202 $ref: '#/components/responses/MethodNotAllowed'
3204 $ref: '#/components/responses/NotAcceptable'
3206 $ref: '#/components/responses/Conflict'
3208 $ref: '#/components/responses/UnprocessableEntity'
3210 $ref: '#/components/responses/InternalServerError'
3212 $ref: '#/components/responses/ServiceUnavailable'
3214 $ref: '#/components/responses/UnexpectedError'
3216 $ref: '#/components/responses/UnexpectedError'
3217 '/nsilcm/v1/nsi_lcm_op_occs':
3220 - "NetSlice instances"
3221 summary: Query information about multiple NetSlice LCM Operation Occurrences
3222 description: Query information about multiple NetSlice LCM Operation Occurrences
3223 operationId: getNsiLcmOpOccs
3230 $ref: '#/components/schemas/ArrayOfNsiLcmOpOcc'
3233 $ref: '#/components/schemas/ArrayOfNsiLcmOpOcc'
3235 $ref: '#/components/responses/BadRequest'
3237 $ref: '#/components/responses/Unauthorized'
3239 $ref: '#/components/responses/Forbidden'
3241 $ref: '#/components/responses/NotFound'
3243 $ref: '#/components/responses/MethodNotAllowed'
3245 $ref: '#/components/responses/NotAcceptable'
3247 $ref: '#/components/responses/Conflict'
3249 $ref: '#/components/responses/UnprocessableEntity'
3251 $ref: '#/components/responses/InternalServerError'
3253 $ref: '#/components/responses/ServiceUnavailable'
3255 $ref: '#/components/responses/UnexpectedError'
3257 $ref: '#/components/responses/UnexpectedError'
3258 '/nsilcm/v1/nsi_lcm_op_occs/{nsiLcmOpOccId}':
3260 - name: nsiLcmOpOccId
3263 description: NetSlice LCM Operation Occurrence ID
3268 - "NetSlice instances"
3269 summary: Query information about an individual NetSlice LCM Operation Occurrence
3270 description: Query information about an individual NetSlice LCM Operation Occurrence
3271 operationId: getNsiLcmOpOcc
3278 $ref: '#/components/schemas/NsiLcmOpOcc'
3281 $ref: '#/components/schemas/NsiLcmOpOcc'
3283 $ref: '#/components/responses/BadRequest'
3285 $ref: '#/components/responses/Unauthorized'
3287 $ref: '#/components/responses/Forbidden'
3289 $ref: '#/components/responses/NotFound'
3291 $ref: '#/components/responses/MethodNotAllowed'
3293 $ref: '#/components/responses/NotAcceptable'
3295 $ref: '#/components/responses/Conflict'
3297 $ref: '#/components/responses/UnprocessableEntity'
3299 $ref: '#/components/responses/InternalServerError'
3301 $ref: '#/components/responses/ServiceUnavailable'
3303 $ref: '#/components/responses/UnexpectedError'
3305 $ref: '#/components/responses/UnexpectedError'
3306 # END NetSlice Instances
3309 '/nspm/v1/pm_jobs/{pmJobId}/reports/{nsId}':
3314 description: NS PM Job ID
3325 - "NS Performance Management"
3326 summary: Query information about an individual NS PM Job Report
3327 description: Query information about an individual NS PM Job Report
3328 operationId: getNsPmJobReport
3335 $ref: '#/components/schemas/NsPmJobReportInfo'
3338 $ref: '#/components/schemas/NsPmJobReportInfo'
3340 $ref: '#/components/responses/BadRequest'
3342 $ref: '#/components/responses/Unauthorized'
3344 $ref: '#/components/responses/Forbidden'
3346 $ref: '#/components/responses/NotFound'
3348 $ref: '#/components/responses/MethodNotAllowed'
3350 $ref: '#/components/responses/NotAcceptable'
3352 $ref: '#/components/responses/Conflict'
3354 $ref: '#/components/responses/UnprocessableEntity'
3356 $ref: '#/components/responses/InternalServerError'
3358 $ref: '#/components/responses/ServiceUnavailable'
3360 $ref: '#/components/responses/UnexpectedError'
3362 $ref: '#/components/responses/UnexpectedError'
3366 '/pdu/v1/pdu_descriptors':
3369 - "Physical Data Units (PDU)"
3370 summary: Query information about multiple PDU Descriptors
3371 description: Query information about multiple PDU Descriptors
3372 operationId: getPDUs
3379 $ref: '#/components/schemas/ArrayOfPduInfo'
3382 $ref: '#/components/schemas/ArrayOfPduInfo'
3384 $ref: '#/components/responses/BadRequest'
3386 $ref: '#/components/responses/Unauthorized'
3388 $ref: '#/components/responses/Forbidden'
3390 $ref: '#/components/responses/NotFound'
3392 $ref: '#/components/responses/MethodNotAllowed'
3394 $ref: '#/components/responses/NotAcceptable'
3396 $ref: '#/components/responses/Conflict'
3398 $ref: '#/components/responses/UnprocessableEntity'
3400 $ref: '#/components/responses/InternalServerError'
3402 $ref: '#/components/responses/ServiceUnavailable'
3404 $ref: '#/components/responses/UnexpectedError'
3406 $ref: '#/components/responses/UnexpectedError'
3409 - "Physical Data Units (PDU)"
3410 summary: Create a new PDU
3411 description: Create a new PDU Descriptor
3412 operationId: createPDU
3414 $ref: '#/components/requestBodies/CreatePduRequest'
3426 $ref: '#/components/schemas/ObjectId'
3429 $ref: '#/components/schemas/ObjectId'
3431 $ref: '#/components/responses/BadRequest'
3433 $ref: '#/components/responses/Unauthorized'
3435 $ref: '#/components/responses/Forbidden'
3437 $ref: '#/components/responses/NotFound'
3439 $ref: '#/components/responses/MethodNotAllowed'
3441 $ref: '#/components/responses/NotAcceptable'
3443 $ref: '#/components/responses/Conflict'
3445 $ref: '#/components/responses/UnprocessableEntity'
3447 $ref: '#/components/responses/InternalServerError'
3449 $ref: '#/components/responses/ServiceUnavailable'
3451 $ref: '#/components/responses/UnexpectedError'
3453 $ref: '#/components/responses/UnexpectedError'
3454 '/pdu/v1/pdu_descriptors/{pduDescriptorId}':
3456 - name: pduDescriptorId
3459 description: PDU Descriptor ID
3464 - "Physical Data Units (PDU)"
3465 summary: Query information about an individual PDU Descriptor
3466 description: Query information about an individual PDU Descriptor
3474 $ref: '#/components/schemas/PduInfo'
3477 $ref: '#/components/schemas/PduInfo'
3479 $ref: '#/components/responses/BadRequest'
3481 $ref: '#/components/responses/Unauthorized'
3483 $ref: '#/components/responses/Forbidden'
3485 $ref: '#/components/responses/NotFound'
3487 $ref: '#/components/responses/MethodNotAllowed'
3489 $ref: '#/components/responses/NotAcceptable'
3491 $ref: '#/components/responses/Conflict'
3493 $ref: '#/components/responses/UnprocessableEntity'
3495 $ref: '#/components/responses/InternalServerError'
3497 $ref: '#/components/responses/ServiceUnavailable'
3499 $ref: '#/components/responses/UnexpectedError'
3501 $ref: '#/components/responses/UnexpectedError'
3504 - "Physical Data Units (PDU)"
3505 summary: Modify an individual PDU Descriptor
3506 description: Modify an individual PDU Descriptor
3507 operationId: editPDU
3509 $ref: '#/components/requestBodies/EditPduRequest'
3512 description: No Content
3514 $ref: '#/components/responses/BadRequest'
3516 $ref: '#/components/responses/Unauthorized'
3518 $ref: '#/components/responses/Forbidden'
3520 $ref: '#/components/responses/NotFound'
3522 $ref: '#/components/responses/MethodNotAllowed'
3524 $ref: '#/components/responses/NotAcceptable'
3526 $ref: '#/components/responses/Conflict'
3528 $ref: '#/components/responses/UnprocessableEntity'
3530 $ref: '#/components/responses/InternalServerError'
3532 $ref: '#/components/responses/ServiceUnavailable'
3534 $ref: '#/components/responses/UnexpectedError'
3536 $ref: '#/components/responses/UnexpectedError'
3539 - "Physical Data Units (PDU)"
3540 summary: Delete an individual PDU Descriptor
3541 description: Delete an individual PDU Descriptor
3542 operationId: deletePDU
3545 description: No Content
3547 $ref: '#/components/responses/BadRequest'
3549 $ref: '#/components/responses/Unauthorized'
3551 $ref: '#/components/responses/Forbidden'
3553 $ref: '#/components/responses/NotFound'
3555 $ref: '#/components/responses/MethodNotAllowed'
3557 $ref: '#/components/responses/NotAcceptable'
3559 $ref: '#/components/responses/Conflict'
3561 $ref: '#/components/responses/UnprocessableEntity'
3563 $ref: '#/components/responses/InternalServerError'
3565 $ref: '#/components/responses/ServiceUnavailable'
3567 $ref: '#/components/responses/UnexpectedError'
3569 $ref: '#/components/responses/UnexpectedError'
3577 summary: Query information about multiple Tokens
3578 description: Query information about multiple Tokens
3579 operationId: getTokens
3586 $ref: '#/components/schemas/ArrayOfTokenInfo'
3589 $ref: '#/components/schemas/ArrayOfTokenInfo'
3591 $ref: '#/components/responses/BadRequest'
3593 $ref: '#/components/responses/Unauthorized'
3595 $ref: '#/components/responses/Forbidden'
3597 $ref: '#/components/responses/NotFound'
3599 $ref: '#/components/responses/MethodNotAllowed'
3601 $ref: '#/components/responses/NotAcceptable'
3603 $ref: '#/components/responses/Conflict'
3605 $ref: '#/components/responses/UnprocessableEntity'
3607 $ref: '#/components/responses/InternalServerError'
3609 $ref: '#/components/responses/ServiceUnavailable'
3611 $ref: '#/components/responses/UnexpectedError'
3613 $ref: '#/components/responses/UnexpectedError'
3617 summary: Request a new Token
3618 description: Request a new Token
3619 operationId: createToken
3621 $ref: '#/components/requestBodies/CreateTokenRequest'
3633 $ref: '#/components/schemas/TokenInfo'
3636 $ref: '#/components/schemas/TokenInfo'
3638 $ref: '#/components/responses/BadRequest'
3640 $ref: '#/components/responses/Unauthorized'
3642 $ref: '#/components/responses/Forbidden'
3644 $ref: '#/components/responses/NotFound'
3646 $ref: '#/components/responses/MethodNotAllowed'
3648 $ref: '#/components/responses/NotAcceptable'
3650 $ref: '#/components/responses/Conflict'
3652 $ref: '#/components/responses/UnprocessableEntity'
3654 $ref: '#/components/responses/InternalServerError'
3656 $ref: '#/components/responses/ServiceUnavailable'
3658 $ref: '#/components/responses/UnexpectedError'
3660 $ref: '#/components/responses/UnexpectedError'
3664 summary: Delete the Token indicated in the Authorization Header
3665 description: Delete the Token indicated in the Authorization Header
3666 operationId: deleteAuthToken
3678 $ref: '#/components/responses/BadRequest'
3680 $ref: '#/components/responses/Unauthorized'
3682 $ref: '#/components/responses/Forbidden'
3684 $ref: '#/components/responses/NotFound'
3686 $ref: '#/components/responses/MethodNotAllowed'
3688 $ref: '#/components/responses/NotAcceptable'
3690 $ref: '#/components/responses/Conflict'
3692 $ref: '#/components/responses/UnprocessableEntity'
3694 $ref: '#/components/responses/InternalServerError'
3696 $ref: '#/components/responses/ServiceUnavailable'
3698 $ref: '#/components/responses/UnexpectedError'
3700 $ref: '#/components/responses/UnexpectedError'
3701 '/admin/v1/tokens/{tokenId}':
3706 description: Token ID
3712 summary: Query information about an individual Token
3713 description: Query information about an individual Token
3714 operationId: getToken
3721 $ref: '#/components/schemas/TokenInfo'
3724 $ref: '#/components/schemas/TokenInfo'
3726 $ref: '#/components/responses/BadRequest'
3728 $ref: '#/components/responses/Unauthorized'
3730 $ref: '#/components/responses/Forbidden'
3732 $ref: '#/components/responses/NotFound'
3734 $ref: '#/components/responses/MethodNotAllowed'
3736 $ref: '#/components/responses/NotAcceptable'
3738 $ref: '#/components/responses/Conflict'
3740 $ref: '#/components/responses/UnprocessableEntity'
3742 $ref: '#/components/responses/InternalServerError'
3744 $ref: '#/components/responses/ServiceUnavailable'
3746 $ref: '#/components/responses/UnexpectedError'
3748 $ref: '#/components/responses/UnexpectedError'
3752 summary: Delete the Token indicated as parameter
3753 description: Delete the Token indicated as parameter
3754 operationId: deleteToken
3766 $ref: '#/components/responses/BadRequest'
3768 $ref: '#/components/responses/Unauthorized'
3770 $ref: '#/components/responses/Forbidden'
3772 $ref: '#/components/responses/NotFound'
3774 $ref: '#/components/responses/MethodNotAllowed'
3776 $ref: '#/components/responses/NotAcceptable'
3778 $ref: '#/components/responses/Conflict'
3780 $ref: '#/components/responses/UnprocessableEntity'
3782 $ref: '#/components/responses/InternalServerError'
3784 $ref: '#/components/responses/ServiceUnavailable'
3786 $ref: '#/components/responses/UnexpectedError'
3788 $ref: '#/components/responses/UnexpectedError'
3793 summary: Query information about multiple Users
3794 description: Query information about multiple Users
3795 operationId: getUsers
3802 $ref: '#/components/schemas/ArrayOfUserInfo'
3805 $ref: '#/components/schemas/ArrayOfUserInfo'
3807 $ref: '#/components/responses/BadRequest'
3809 $ref: '#/components/responses/Unauthorized'
3811 $ref: '#/components/responses/Forbidden'
3813 $ref: '#/components/responses/NotFound'
3815 $ref: '#/components/responses/MethodNotAllowed'
3817 $ref: '#/components/responses/NotAcceptable'
3819 $ref: '#/components/responses/Conflict'
3821 $ref: '#/components/responses/UnprocessableEntity'
3823 $ref: '#/components/responses/InternalServerError'
3825 $ref: '#/components/responses/ServiceUnavailable'
3827 $ref: '#/components/responses/UnexpectedError'
3829 $ref: '#/components/responses/UnexpectedError'
3833 summary: Create a new User
3834 description: Create a new User
3835 operationId: createUser
3837 $ref: '#/components/requestBodies/CreateUserRequest'
3840 description: Created
3849 $ref: '#/components/schemas/ObjectId'
3852 $ref: '#/components/schemas/ObjectId'
3854 $ref: '#/components/responses/BadRequest'
3856 $ref: '#/components/responses/Unauthorized'
3858 $ref: '#/components/responses/Forbidden'
3860 $ref: '#/components/responses/NotFound'
3862 $ref: '#/components/responses/MethodNotAllowed'
3864 $ref: '#/components/responses/NotAcceptable'
3866 $ref: '#/components/responses/Conflict'
3868 $ref: '#/components/responses/UnprocessableEntity'
3870 $ref: '#/components/responses/InternalServerError'
3872 $ref: '#/components/responses/ServiceUnavailable'
3874 $ref: '#/components/responses/UnexpectedError'
3876 $ref: '#/components/responses/UnexpectedError'
3877 '/admin/v1/users/{userId}':
3882 description: User ID/Name
3888 summary: Query information about an individual User
3889 description: Query information about an individual User
3890 operationId: getUser
3897 $ref: '#/components/schemas/UserInfo'
3900 $ref: '#/components/schemas/UserInfo'
3902 $ref: '#/components/responses/BadRequest'
3904 $ref: '#/components/responses/Unauthorized'
3906 $ref: '#/components/responses/Forbidden'
3908 $ref: '#/components/responses/NotFound'
3910 $ref: '#/components/responses/MethodNotAllowed'
3912 $ref: '#/components/responses/NotAcceptable'
3914 $ref: '#/components/responses/Conflict'
3916 $ref: '#/components/responses/UnprocessableEntity'
3918 $ref: '#/components/responses/InternalServerError'
3920 $ref: '#/components/responses/ServiceUnavailable'
3922 $ref: '#/components/responses/UnexpectedError'
3924 $ref: '#/components/responses/UnexpectedError'
3928 summary: Modify a User
3929 description: Modify a User
3930 operationId: editUser
3932 $ref: '#/components/requestBodies/EditUserRequest'
3935 description: No Content
3937 $ref: '#/components/responses/BadRequest'
3939 $ref: '#/components/responses/Unauthorized'
3941 $ref: '#/components/responses/Forbidden'
3943 $ref: '#/components/responses/NotFound'
3945 $ref: '#/components/responses/MethodNotAllowed'
3947 $ref: '#/components/responses/NotAcceptable'
3949 $ref: '#/components/responses/Conflict'
3951 $ref: '#/components/responses/UnprocessableEntity'
3953 $ref: '#/components/responses/InternalServerError'
3955 $ref: '#/components/responses/ServiceUnavailable'
3957 $ref: '#/components/responses/UnexpectedError'
3959 $ref: '#/components/responses/UnexpectedError'
3963 summary: Delete a User
3964 description: Delete a User
3965 operationId: deleteUser
3968 description: No Content
3970 $ref: '#/components/responses/BadRequest'
3972 $ref: '#/components/responses/Unauthorized'
3974 $ref: '#/components/responses/Forbidden'
3976 $ref: '#/components/responses/NotFound'
3978 $ref: '#/components/responses/MethodNotAllowed'
3980 $ref: '#/components/responses/NotAcceptable'
3982 $ref: '#/components/responses/Conflict'
3984 $ref: '#/components/responses/UnprocessableEntity'
3986 $ref: '#/components/responses/InternalServerError'
3988 $ref: '#/components/responses/ServiceUnavailable'
3990 $ref: '#/components/responses/UnexpectedError'
3992 $ref: '#/components/responses/UnexpectedError'
3993 '/admin/v1/projects':
3997 summary: Query information about multiple Projects
3998 description: Query information about multiple Projects
3999 operationId: getProjects
4006 $ref: '#/components/schemas/ArrayOfProjectInfo'
4009 $ref: '#/components/schemas/ArrayOfProjectInfo'
4011 $ref: '#/components/responses/BadRequest'
4013 $ref: '#/components/responses/Unauthorized'
4015 $ref: '#/components/responses/Forbidden'
4017 $ref: '#/components/responses/NotFound'
4019 $ref: '#/components/responses/MethodNotAllowed'
4021 $ref: '#/components/responses/NotAcceptable'
4023 $ref: '#/components/responses/Conflict'
4025 $ref: '#/components/responses/UnprocessableEntity'
4027 $ref: '#/components/responses/InternalServerError'
4029 $ref: '#/components/responses/ServiceUnavailable'
4031 $ref: '#/components/responses/UnexpectedError'
4033 $ref: '#/components/responses/UnexpectedError'
4037 summary: Create a new Project
4038 description: Create a new Project
4039 operationId: createProject
4041 $ref: '#/components/requestBodies/CreateProjectRequest'
4044 description: Created
4053 $ref: '#/components/schemas/ObjectId'
4056 $ref: '#/components/schemas/ObjectId'
4058 $ref: '#/components/responses/BadRequest'
4060 $ref: '#/components/responses/Unauthorized'
4062 $ref: '#/components/responses/Forbidden'
4064 $ref: '#/components/responses/NotFound'
4066 $ref: '#/components/responses/MethodNotAllowed'
4068 $ref: '#/components/responses/NotAcceptable'
4070 $ref: '#/components/responses/Conflict'
4072 $ref: '#/components/responses/UnprocessableEntity'
4074 $ref: '#/components/responses/InternalServerError'
4076 $ref: '#/components/responses/ServiceUnavailable'
4078 $ref: '#/components/responses/UnexpectedError'
4080 $ref: '#/components/responses/UnexpectedError'
4081 '/admin/v1/projects/{projectId}':
4086 description: Project ID/Name
4092 summary: Query information about an individual Project
4093 description: Query information about an individual Project
4094 operationId: getProject
4101 $ref: '#/components/schemas/ProjectInfo'
4104 $ref: '#/components/schemas/ProjectInfo'
4106 $ref: '#/components/responses/BadRequest'
4108 $ref: '#/components/responses/Unauthorized'
4110 $ref: '#/components/responses/Forbidden'
4112 $ref: '#/components/responses/NotFound'
4114 $ref: '#/components/responses/MethodNotAllowed'
4116 $ref: '#/components/responses/NotAcceptable'
4118 $ref: '#/components/responses/Conflict'
4120 $ref: '#/components/responses/UnprocessableEntity'
4122 $ref: '#/components/responses/InternalServerError'
4124 $ref: '#/components/responses/ServiceUnavailable'
4126 $ref: '#/components/responses/UnexpectedError'
4128 $ref: '#/components/responses/UnexpectedError'
4132 summary: Modify a Project
4133 description: Modify a Project
4134 operationId: editProject
4136 $ref: '#/components/requestBodies/EditProjectRequest'
4139 description: No Content
4141 $ref: '#/components/responses/BadRequest'
4143 $ref: '#/components/responses/Unauthorized'
4145 $ref: '#/components/responses/Forbidden'
4147 $ref: '#/components/responses/NotFound'
4149 $ref: '#/components/responses/MethodNotAllowed'
4151 $ref: '#/components/responses/NotAcceptable'
4153 $ref: '#/components/responses/Conflict'
4155 $ref: '#/components/responses/UnprocessableEntity'
4157 $ref: '#/components/responses/InternalServerError'
4159 $ref: '#/components/responses/ServiceUnavailable'
4161 $ref: '#/components/responses/UnexpectedError'
4163 $ref: '#/components/responses/UnexpectedError'
4167 summary: Delete a Project
4168 description: Delete a Project
4169 operationId: deleteProject
4172 description: No Content
4174 $ref: '#/components/responses/BadRequest'
4176 $ref: '#/components/responses/Unauthorized'
4178 $ref: '#/components/responses/Forbidden'
4180 $ref: '#/components/responses/NotFound'
4182 $ref: '#/components/responses/MethodNotAllowed'
4184 $ref: '#/components/responses/NotAcceptable'
4186 $ref: '#/components/responses/Conflict'
4188 $ref: '#/components/responses/UnprocessableEntity'
4190 $ref: '#/components/responses/InternalServerError'
4192 $ref: '#/components/responses/ServiceUnavailable'
4194 $ref: '#/components/responses/UnexpectedError'
4196 $ref: '#/components/responses/UnexpectedError'
4201 summary: Query information about multiple Roles
4202 description: Query information about multiple Roles
4203 operationId: getRoles
4210 $ref: '#/components/schemas/ArrayOfRoleInfo'
4213 $ref: '#/components/schemas/ArrayOfRoleInfo'
4215 $ref: '#/components/responses/BadRequest'
4217 $ref: '#/components/responses/Unauthorized'
4219 $ref: '#/components/responses/Forbidden'
4221 $ref: '#/components/responses/NotFound'
4223 $ref: '#/components/responses/MethodNotAllowed'
4225 $ref: '#/components/responses/NotAcceptable'
4227 $ref: '#/components/responses/Conflict'
4229 $ref: '#/components/responses/UnprocessableEntity'
4231 $ref: '#/components/responses/InternalServerError'
4233 $ref: '#/components/responses/ServiceUnavailable'
4235 $ref: '#/components/responses/UnexpectedError'
4237 $ref: '#/components/responses/UnexpectedError'
4241 summary: Create a new Role
4242 description: Create a new Role
4243 operationId: createRole
4245 $ref: '#/components/requestBodies/CreateRoleRequest'
4248 description: Created
4257 $ref: '#/components/schemas/ObjectId'
4260 $ref: '#/components/schemas/ObjectId'
4262 $ref: '#/components/responses/BadRequest'
4264 $ref: '#/components/responses/Unauthorized'
4266 $ref: '#/components/responses/Forbidden'
4268 $ref: '#/components/responses/NotFound'
4270 $ref: '#/components/responses/MethodNotAllowed'
4272 $ref: '#/components/responses/NotAcceptable'
4274 $ref: '#/components/responses/Conflict'
4276 $ref: '#/components/responses/UnprocessableEntity'
4278 $ref: '#/components/responses/InternalServerError'
4280 $ref: '#/components/responses/ServiceUnavailable'
4282 $ref: '#/components/responses/UnexpectedError'
4284 $ref: '#/components/responses/UnexpectedError'
4285 '/admin/v1/roles/{roleId}':
4290 description: Role ID/Name
4296 summary: Query information about an individual Role
4297 description: Query information about an individual Role
4298 operationId: getRole
4305 $ref: '#/components/schemas/RoleInfo'
4308 $ref: '#/components/schemas/RoleInfo'
4310 $ref: '#/components/responses/BadRequest'
4312 $ref: '#/components/responses/Unauthorized'
4314 $ref: '#/components/responses/Forbidden'
4316 $ref: '#/components/responses/NotFound'
4318 $ref: '#/components/responses/MethodNotAllowed'
4320 $ref: '#/components/responses/NotAcceptable'
4322 $ref: '#/components/responses/Conflict'
4324 $ref: '#/components/responses/UnprocessableEntity'
4326 $ref: '#/components/responses/InternalServerError'
4328 $ref: '#/components/responses/ServiceUnavailable'
4330 $ref: '#/components/responses/UnexpectedError'
4332 $ref: '#/components/responses/UnexpectedError'
4336 summary: Modify a Role
4337 description: Modify a Role
4338 operationId: editRole
4340 $ref: '#/components/requestBodies/EditRoleRequest'
4343 description: No Content
4345 $ref: '#/components/responses/BadRequest'
4347 $ref: '#/components/responses/Unauthorized'
4349 $ref: '#/components/responses/Forbidden'
4351 $ref: '#/components/responses/NotFound'
4353 $ref: '#/components/responses/MethodNotAllowed'
4355 $ref: '#/components/responses/NotAcceptable'
4357 $ref: '#/components/responses/Conflict'
4359 $ref: '#/components/responses/UnprocessableEntity'
4361 $ref: '#/components/responses/InternalServerError'
4363 $ref: '#/components/responses/ServiceUnavailable'
4365 $ref: '#/components/responses/UnexpectedError'
4367 $ref: '#/components/responses/UnexpectedError'
4371 summary: Delete a Role
4372 description: Delete a Role
4373 operationId: deleteRole
4376 description: No Content
4378 $ref: '#/components/responses/BadRequest'
4380 $ref: '#/components/responses/Unauthorized'
4382 $ref: '#/components/responses/Forbidden'
4384 $ref: '#/components/responses/NotFound'
4386 $ref: '#/components/responses/MethodNotAllowed'
4388 $ref: '#/components/responses/NotAcceptable'
4390 $ref: '#/components/responses/Conflict'
4392 $ref: '#/components/responses/UnprocessableEntity'
4394 $ref: '#/components/responses/InternalServerError'
4396 $ref: '#/components/responses/ServiceUnavailable'
4398 $ref: '#/components/responses/UnexpectedError'
4400 $ref: '#/components/responses/UnexpectedError'
4405 summary: Query information about multiple VIMs
4406 description: Query information about multiple VIMs
4407 operationId: getVIMs
4414 $ref: '#/components/schemas/ArrayOfVimInfo'
4417 $ref: '#/components/schemas/ArrayOfVimInfo'
4419 $ref: '#/components/responses/BadRequest'
4421 $ref: '#/components/responses/Unauthorized'
4423 $ref: '#/components/responses/Forbidden'
4425 $ref: '#/components/responses/NotFound'
4427 $ref: '#/components/responses/MethodNotAllowed'
4429 $ref: '#/components/responses/NotAcceptable'
4431 $ref: '#/components/responses/Conflict'
4433 $ref: '#/components/responses/UnprocessableEntity'
4435 $ref: '#/components/responses/InternalServerError'
4437 $ref: '#/components/responses/ServiceUnavailable'
4439 $ref: '#/components/responses/UnexpectedError'
4441 $ref: '#/components/responses/UnexpectedError'
4445 summary: Create a new VIM
4446 description: Create a new VIM
4447 operationId: createVIM
4449 $ref: '#/components/requestBodies/CreateVimRequest'
4452 description: Accepted
4456 $ref: '#/components/schemas/ObjectId_plus_OpId'
4459 $ref: '#/components/schemas/ObjectId_plus_OpId'
4461 $ref: '#/components/responses/BadRequest'
4463 $ref: '#/components/responses/Unauthorized'
4465 $ref: '#/components/responses/Forbidden'
4467 $ref: '#/components/responses/NotFound'
4469 $ref: '#/components/responses/MethodNotAllowed'
4471 $ref: '#/components/responses/NotAcceptable'
4473 $ref: '#/components/responses/Conflict'
4475 $ref: '#/components/responses/UnprocessableEntity'
4477 $ref: '#/components/responses/InternalServerError'
4479 $ref: '#/components/responses/ServiceUnavailable'
4481 $ref: '#/components/responses/UnexpectedError'
4483 $ref: '#/components/responses/UnexpectedError'
4484 '/admin/v1/vims/{vimId}':
4496 summary: Query information about an individual VIM
4497 description: Query information about an individual VIM
4505 $ref: '#/components/schemas/VimInfo'
4508 $ref: '#/components/schemas/VimInfo'
4510 $ref: '#/components/responses/BadRequest'
4512 $ref: '#/components/responses/Unauthorized'
4514 $ref: '#/components/responses/Forbidden'
4516 $ref: '#/components/responses/NotFound'
4518 $ref: '#/components/responses/MethodNotAllowed'
4520 $ref: '#/components/responses/NotAcceptable'
4522 $ref: '#/components/responses/Conflict'
4524 $ref: '#/components/responses/UnprocessableEntity'
4526 $ref: '#/components/responses/InternalServerError'
4528 $ref: '#/components/responses/ServiceUnavailable'
4530 $ref: '#/components/responses/UnexpectedError'
4532 $ref: '#/components/responses/UnexpectedError'
4536 summary: Modify a VIM
4537 description: Modify a VIM
4538 operationId: editVIM
4540 $ref: '#/components/requestBodies/EditVimRequest'
4543 description: Accepted
4547 $ref: '#/components/schemas/OpId'
4550 $ref: '#/components/schemas/OpId'
4552 $ref: '#/components/responses/BadRequest'
4554 $ref: '#/components/responses/Unauthorized'
4556 $ref: '#/components/responses/Forbidden'
4558 $ref: '#/components/responses/NotFound'
4560 $ref: '#/components/responses/MethodNotAllowed'
4562 $ref: '#/components/responses/NotAcceptable'
4564 $ref: '#/components/responses/Conflict'
4566 $ref: '#/components/responses/UnprocessableEntity'
4568 $ref: '#/components/responses/InternalServerError'
4570 $ref: '#/components/responses/ServiceUnavailable'
4572 $ref: '#/components/responses/UnexpectedError'
4574 $ref: '#/components/responses/UnexpectedError'
4578 summary: Delete a VIM
4579 description: Delete a VIM
4580 operationId: deleteVIM
4583 description: Accepted
4585 $ref: '#/components/responses/BadRequest'
4587 $ref: '#/components/responses/Unauthorized'
4589 $ref: '#/components/responses/Forbidden'
4591 $ref: '#/components/responses/NotFound'
4593 $ref: '#/components/responses/MethodNotAllowed'
4595 $ref: '#/components/responses/NotAcceptable'
4597 $ref: '#/components/responses/Conflict'
4599 $ref: '#/components/responses/UnprocessableEntity'
4601 $ref: '#/components/responses/InternalServerError'
4603 $ref: '#/components/responses/ServiceUnavailable'
4605 $ref: '#/components/responses/UnexpectedError'
4607 $ref: '#/components/responses/UnexpectedError'
4608 '/admin/v1/vim_accounts':
4612 summary: Query information about multiple VIM Accounts
4613 description: Query information about multiple VIM Accounts
4614 operationId: getVimAccounts
4621 $ref: '#/components/schemas/ArrayOfVimInfo'
4624 $ref: '#/components/schemas/ArrayOfVimInfo'
4626 $ref: '#/components/responses/BadRequest'
4628 $ref: '#/components/responses/Unauthorized'
4630 $ref: '#/components/responses/Forbidden'
4632 $ref: '#/components/responses/NotFound'
4634 $ref: '#/components/responses/MethodNotAllowed'
4636 $ref: '#/components/responses/NotAcceptable'
4638 $ref: '#/components/responses/Conflict'
4640 $ref: '#/components/responses/UnprocessableEntity'
4642 $ref: '#/components/responses/InternalServerError'
4644 $ref: '#/components/responses/ServiceUnavailable'
4646 $ref: '#/components/responses/UnexpectedError'
4648 $ref: '#/components/responses/UnexpectedError'
4652 summary: Create a new VIM Account
4653 description: Create a new VIM Account
4654 operationId: createVimAccount
4656 $ref: '#/components/requestBodies/CreateVimRequest'
4659 description: Accepted
4663 $ref: '#/components/schemas/ObjectId_plus_OpId'
4666 $ref: '#/components/schemas/ObjectId_plus_OpId'
4668 $ref: '#/components/responses/BadRequest'
4670 $ref: '#/components/responses/Unauthorized'
4672 $ref: '#/components/responses/Forbidden'
4674 $ref: '#/components/responses/NotFound'
4676 $ref: '#/components/responses/MethodNotAllowed'
4678 $ref: '#/components/responses/NotAcceptable'
4680 $ref: '#/components/responses/Conflict'
4682 $ref: '#/components/responses/UnprocessableEntity'
4684 $ref: '#/components/responses/InternalServerError'
4686 $ref: '#/components/responses/ServiceUnavailable'
4688 $ref: '#/components/responses/UnexpectedError'
4690 $ref: '#/components/responses/UnexpectedError'
4691 '/admin/v1/vim_accounts/{vimAccountId}':
4693 - name: vimAccountId
4696 description: VIM Account ID
4703 summary: Query information about an individual VIM Account
4704 description: Query information about an individual VIM Account
4705 operationId: getVimAccount
4712 $ref: '#/components/schemas/VimInfo'
4715 $ref: '#/components/schemas/VimInfo'
4717 $ref: '#/components/responses/BadRequest'
4719 $ref: '#/components/responses/Unauthorized'
4721 $ref: '#/components/responses/Forbidden'
4723 $ref: '#/components/responses/NotFound'
4725 $ref: '#/components/responses/MethodNotAllowed'
4727 $ref: '#/components/responses/NotAcceptable'
4729 $ref: '#/components/responses/Conflict'
4731 $ref: '#/components/responses/UnprocessableEntity'
4733 $ref: '#/components/responses/InternalServerError'
4735 $ref: '#/components/responses/ServiceUnavailable'
4737 $ref: '#/components/responses/UnexpectedError'
4739 $ref: '#/components/responses/UnexpectedError'
4743 summary: Modify a VIM Account
4744 description: Modify a VIM Account
4745 operationId: editVimAccount
4747 $ref: '#/components/requestBodies/EditVimRequest'
4750 description: Accepted
4754 $ref: '#/components/schemas/OpId'
4757 $ref: '#/components/schemas/OpId'
4759 $ref: '#/components/responses/BadRequest'
4761 $ref: '#/components/responses/Unauthorized'
4763 $ref: '#/components/responses/Forbidden'
4765 $ref: '#/components/responses/NotFound'
4767 $ref: '#/components/responses/MethodNotAllowed'
4769 $ref: '#/components/responses/NotAcceptable'
4771 $ref: '#/components/responses/Conflict'
4773 $ref: '#/components/responses/UnprocessableEntity'
4775 $ref: '#/components/responses/InternalServerError'
4777 $ref: '#/components/responses/ServiceUnavailable'
4779 $ref: '#/components/responses/UnexpectedError'
4781 $ref: '#/components/responses/UnexpectedError'
4785 summary: Delete a VIM Account
4786 description: Delete a VIM Account
4787 operationId: deleteVimAccount
4790 description: Accepted
4792 $ref: '#/components/responses/BadRequest'
4794 $ref: '#/components/responses/Unauthorized'
4796 $ref: '#/components/responses/Forbidden'
4798 $ref: '#/components/responses/NotFound'
4800 $ref: '#/components/responses/MethodNotAllowed'
4802 $ref: '#/components/responses/NotAcceptable'
4804 $ref: '#/components/responses/Conflict'
4806 $ref: '#/components/responses/UnprocessableEntity'
4808 $ref: '#/components/responses/InternalServerError'
4810 $ref: '#/components/responses/ServiceUnavailable'
4812 $ref: '#/components/responses/UnexpectedError'
4814 $ref: '#/components/responses/UnexpectedError'
4815 '/admin/v1/wim_accounts':
4819 summary: Query information about multiple WIM Accounts
4820 description: Query information about multiple WIM Accounts
4821 operationId: getWimAccounts
4828 $ref: '#/components/schemas/ArrayOfWimInfo'
4831 $ref: '#/components/schemas/ArrayOfWimInfo'
4833 $ref: '#/components/responses/BadRequest'
4835 $ref: '#/components/responses/Unauthorized'
4837 $ref: '#/components/responses/Forbidden'
4839 $ref: '#/components/responses/NotFound'
4841 $ref: '#/components/responses/MethodNotAllowed'
4843 $ref: '#/components/responses/NotAcceptable'
4845 $ref: '#/components/responses/Conflict'
4847 $ref: '#/components/responses/UnprocessableEntity'
4849 $ref: '#/components/responses/InternalServerError'
4851 $ref: '#/components/responses/ServiceUnavailable'
4853 $ref: '#/components/responses/UnexpectedError'
4855 $ref: '#/components/responses/UnexpectedError'
4859 summary: Create a new WIM Account
4860 description: Create a new WIM Account
4861 operationId: createWimAccount
4863 $ref: '#/components/requestBodies/CreateWimRequest'
4866 description: Accepted
4870 $ref: '#/components/schemas/ObjectId_plus_OpId'
4873 $ref: '#/components/schemas/ObjectId_plus_OpId'
4875 $ref: '#/components/responses/BadRequest'
4877 $ref: '#/components/responses/Unauthorized'
4879 $ref: '#/components/responses/Forbidden'
4881 $ref: '#/components/responses/NotFound'
4883 $ref: '#/components/responses/MethodNotAllowed'
4885 $ref: '#/components/responses/NotAcceptable'
4887 $ref: '#/components/responses/Conflict'
4889 $ref: '#/components/responses/UnprocessableEntity'
4891 $ref: '#/components/responses/InternalServerError'
4893 $ref: '#/components/responses/ServiceUnavailable'
4895 $ref: '#/components/responses/UnexpectedError'
4897 $ref: '#/components/responses/UnexpectedError'
4898 '/admin/v1/wim_accounts/{wimAccountId}':
4900 - name: wimAccountId
4903 description: WIM Account ID
4910 summary: Query information about an individual WIM Account
4911 description: Query information about an individual WIM Account
4912 operationId: getWimAccount
4919 $ref: '#/components/schemas/WimInfo'
4922 $ref: '#/components/schemas/WimInfo'
4924 $ref: '#/components/responses/BadRequest'
4926 $ref: '#/components/responses/Unauthorized'
4928 $ref: '#/components/responses/Forbidden'
4930 $ref: '#/components/responses/NotFound'
4932 $ref: '#/components/responses/MethodNotAllowed'
4934 $ref: '#/components/responses/NotAcceptable'
4936 $ref: '#/components/responses/Conflict'
4938 $ref: '#/components/responses/UnprocessableEntity'
4940 $ref: '#/components/responses/InternalServerError'
4942 $ref: '#/components/responses/ServiceUnavailable'
4944 $ref: '#/components/responses/UnexpectedError'
4946 $ref: '#/components/responses/UnexpectedError'
4950 summary: Modify a WIM Account
4951 description: Modify a WIM Account
4952 operationId: editWimAccount
4954 $ref: '#/components/requestBodies/EditWimRequest'
4957 description: Accepted
4961 $ref: '#/components/schemas/OpId'
4964 $ref: '#/components/schemas/OpId'
4966 $ref: '#/components/responses/BadRequest'
4968 $ref: '#/components/responses/Unauthorized'
4970 $ref: '#/components/responses/Forbidden'
4972 $ref: '#/components/responses/NotFound'
4974 $ref: '#/components/responses/MethodNotAllowed'
4976 $ref: '#/components/responses/NotAcceptable'
4978 $ref: '#/components/responses/Conflict'
4980 $ref: '#/components/responses/UnprocessableEntity'
4982 $ref: '#/components/responses/InternalServerError'
4984 $ref: '#/components/responses/ServiceUnavailable'
4986 $ref: '#/components/responses/UnexpectedError'
4988 $ref: '#/components/responses/UnexpectedError'
4992 summary: Delete a WIM Account
4993 description: Delete a WIM Account
4994 operationId: deleteWimAccount
4997 description: Accepted
4999 $ref: '#/components/responses/BadRequest'
5001 $ref: '#/components/responses/Unauthorized'
5003 $ref: '#/components/responses/Forbidden'
5005 $ref: '#/components/responses/NotFound'
5007 $ref: '#/components/responses/MethodNotAllowed'
5009 $ref: '#/components/responses/NotAcceptable'
5011 $ref: '#/components/responses/Conflict'
5013 $ref: '#/components/responses/UnprocessableEntity'
5015 $ref: '#/components/responses/InternalServerError'
5017 $ref: '#/components/responses/ServiceUnavailable'
5019 $ref: '#/components/responses/UnexpectedError'
5021 $ref: '#/components/responses/UnexpectedError'
5026 summary: Query information about multiple SDNs
5027 description: Query information about multiple SDNs
5028 operationId: getSDNs
5035 $ref: '#/components/schemas/ArrayOfSdnInfo'
5038 $ref: '#/components/schemas/ArrayOfSdnInfo'
5040 $ref: '#/components/responses/BadRequest'
5042 $ref: '#/components/responses/Unauthorized'
5044 $ref: '#/components/responses/Forbidden'
5046 $ref: '#/components/responses/NotFound'
5048 $ref: '#/components/responses/MethodNotAllowed'
5050 $ref: '#/components/responses/NotAcceptable'
5052 $ref: '#/components/responses/Conflict'
5054 $ref: '#/components/responses/UnprocessableEntity'
5056 $ref: '#/components/responses/InternalServerError'
5058 $ref: '#/components/responses/ServiceUnavailable'
5060 $ref: '#/components/responses/UnexpectedError'
5062 $ref: '#/components/responses/UnexpectedError'
5066 summary: Create a new SDN
5067 description: Create a new SDN
5068 operationId: createSDN
5070 $ref: '#/components/requestBodies/CreateSdnRequest'
5073 description: Accepted
5077 $ref: '#/components/schemas/ObjectId_plus_OpId'
5080 $ref: '#/components/schemas/ObjectId_plus_OpId'
5082 $ref: '#/components/responses/BadRequest'
5084 $ref: '#/components/responses/Unauthorized'
5086 $ref: '#/components/responses/Forbidden'
5088 $ref: '#/components/responses/NotFound'
5090 $ref: '#/components/responses/MethodNotAllowed'
5092 $ref: '#/components/responses/NotAcceptable'
5094 $ref: '#/components/responses/Conflict'
5096 $ref: '#/components/responses/UnprocessableEntity'
5098 $ref: '#/components/responses/InternalServerError'
5100 $ref: '#/components/responses/ServiceUnavailable'
5102 $ref: '#/components/responses/UnexpectedError'
5104 $ref: '#/components/responses/UnexpectedError'
5105 '/admin/v1/sdns/{sdnId}':
5117 summary: Query information about an individual SDN
5118 description: Query information about an individual SDN
5126 $ref: '#/components/schemas/SdnInfo'
5129 $ref: '#/components/schemas/SdnInfo'
5131 $ref: '#/components/responses/BadRequest'
5133 $ref: '#/components/responses/Unauthorized'
5135 $ref: '#/components/responses/Forbidden'
5137 $ref: '#/components/responses/NotFound'
5139 $ref: '#/components/responses/MethodNotAllowed'
5141 $ref: '#/components/responses/NotAcceptable'
5143 $ref: '#/components/responses/Conflict'
5145 $ref: '#/components/responses/UnprocessableEntity'
5147 $ref: '#/components/responses/InternalServerError'
5149 $ref: '#/components/responses/ServiceUnavailable'
5151 $ref: '#/components/responses/UnexpectedError'
5153 $ref: '#/components/responses/UnexpectedError'
5157 summary: Modify a SDN
5158 description: Modify a SDN
5159 operationId: editSDN
5161 $ref: '#/components/requestBodies/EditSdnRequest'
5164 description: Accepted
5168 $ref: '#/components/schemas/OpId'
5171 $ref: '#/components/schemas/OpId'
5173 $ref: '#/components/responses/BadRequest'
5175 $ref: '#/components/responses/Unauthorized'
5177 $ref: '#/components/responses/Forbidden'
5179 $ref: '#/components/responses/NotFound'
5181 $ref: '#/components/responses/MethodNotAllowed'
5183 $ref: '#/components/responses/NotAcceptable'
5185 $ref: '#/components/responses/Conflict'
5187 $ref: '#/components/responses/UnprocessableEntity'
5189 $ref: '#/components/responses/InternalServerError'
5191 $ref: '#/components/responses/ServiceUnavailable'
5193 $ref: '#/components/responses/UnexpectedError'
5195 $ref: '#/components/responses/UnexpectedError'
5199 summary: Delete a SDN
5200 description: Delete a SDN
5201 operationId: deleteSDN
5204 description: Accepted
5206 $ref: '#/components/responses/BadRequest'
5208 $ref: '#/components/responses/Unauthorized'
5210 $ref: '#/components/responses/Forbidden'
5212 $ref: '#/components/responses/NotFound'
5214 $ref: '#/components/responses/MethodNotAllowed'
5216 $ref: '#/components/responses/NotAcceptable'
5218 $ref: '#/components/responses/Conflict'
5220 $ref: '#/components/responses/UnprocessableEntity'
5222 $ref: '#/components/responses/InternalServerError'
5224 $ref: '#/components/responses/ServiceUnavailable'
5226 $ref: '#/components/responses/UnexpectedError'
5228 $ref: '#/components/responses/UnexpectedError'
5229 '/admin/v1/k8sclusters':
5233 summary: Query information about multiple K8s Clusters
5234 description: Query information about multiple K8s Clusters
5235 operationId: getK8sClusters
5242 $ref: '#/components/schemas/ArrayOfK8sClusterInfo'
5245 $ref: '#/components/schemas/ArrayOfK8sClusterInfo'
5247 $ref: '#/components/responses/BadRequest'
5249 $ref: '#/components/responses/Unauthorized'
5251 $ref: '#/components/responses/Forbidden'
5253 $ref: '#/components/responses/NotFound'
5255 $ref: '#/components/responses/MethodNotAllowed'
5257 $ref: '#/components/responses/NotAcceptable'
5259 $ref: '#/components/responses/Conflict'
5261 $ref: '#/components/responses/UnprocessableEntity'
5263 $ref: '#/components/responses/InternalServerError'
5265 $ref: '#/components/responses/ServiceUnavailable'
5267 $ref: '#/components/responses/UnexpectedError'
5269 $ref: '#/components/responses/UnexpectedError'
5273 summary: Create a new K8s Cluster
5274 description: Create a new K8s Cluster
5275 operationId: createK8sCluster
5277 $ref: '#/components/requestBodies/CreateK8sClusterRequest'
5280 description: Accepted
5284 $ref: '#/components/schemas/ObjectId_plus_OpId'
5287 $ref: '#/components/schemas/ObjectId_plus_OpId'
5289 $ref: '#/components/responses/BadRequest'
5291 $ref: '#/components/responses/Unauthorized'
5293 $ref: '#/components/responses/Forbidden'
5295 $ref: '#/components/responses/NotFound'
5297 $ref: '#/components/responses/MethodNotAllowed'
5299 $ref: '#/components/responses/NotAcceptable'
5301 $ref: '#/components/responses/Conflict'
5303 $ref: '#/components/responses/UnprocessableEntity'
5305 $ref: '#/components/responses/InternalServerError'
5307 $ref: '#/components/responses/ServiceUnavailable'
5309 $ref: '#/components/responses/UnexpectedError'
5311 $ref: '#/components/responses/UnexpectedError'
5312 '/admin/v1/k8sclusters/{k8sClusterId}':
5314 - name: k8sClusterId
5317 description: K8s Cluster ID
5324 summary: Query information about an individual K8s Cluster
5325 description: Query information about an individual K8s Cluster
5326 operationId: getK8sCluster
5333 $ref: '#/components/schemas/K8sClusterInfo'
5336 $ref: '#/components/schemas/K8sClusterInfo'
5338 $ref: '#/components/responses/BadRequest'
5340 $ref: '#/components/responses/Unauthorized'
5342 $ref: '#/components/responses/Forbidden'
5344 $ref: '#/components/responses/NotFound'
5346 $ref: '#/components/responses/MethodNotAllowed'
5348 $ref: '#/components/responses/NotAcceptable'
5350 $ref: '#/components/responses/Conflict'
5352 $ref: '#/components/responses/UnprocessableEntity'
5354 $ref: '#/components/responses/InternalServerError'
5356 $ref: '#/components/responses/ServiceUnavailable'
5358 $ref: '#/components/responses/UnexpectedError'
5360 $ref: '#/components/responses/UnexpectedError'
5364 summary: Modify a K8s Cluster
5365 description: Modify a K8s Cluster
5366 operationId: editK8sCluster
5368 $ref: '#/components/requestBodies/EditK8sClusterRequest'
5371 description: Accepted
5375 $ref: '#/components/schemas/OpId'
5378 $ref: '#/components/schemas/OpId'
5380 $ref: '#/components/responses/BadRequest'
5382 $ref: '#/components/responses/Unauthorized'
5384 $ref: '#/components/responses/Forbidden'
5386 $ref: '#/components/responses/NotFound'
5388 $ref: '#/components/responses/MethodNotAllowed'
5390 $ref: '#/components/responses/NotAcceptable'
5392 $ref: '#/components/responses/Conflict'
5394 $ref: '#/components/responses/UnprocessableEntity'
5396 $ref: '#/components/responses/InternalServerError'
5398 $ref: '#/components/responses/ServiceUnavailable'
5400 $ref: '#/components/responses/UnexpectedError'
5402 $ref: '#/components/responses/UnexpectedError'
5406 summary: Delete a K8s Cluster
5407 description: Delete a K8s Cluster
5408 operationId: deleteK8sCluster
5411 description: Accepted
5413 $ref: '#/components/responses/BadRequest'
5415 $ref: '#/components/responses/Unauthorized'
5417 $ref: '#/components/responses/Forbidden'
5419 $ref: '#/components/responses/NotFound'
5421 $ref: '#/components/responses/MethodNotAllowed'
5423 $ref: '#/components/responses/NotAcceptable'
5425 $ref: '#/components/responses/Conflict'
5427 $ref: '#/components/responses/UnprocessableEntity'
5429 $ref: '#/components/responses/InternalServerError'
5431 $ref: '#/components/responses/ServiceUnavailable'
5433 $ref: '#/components/responses/UnexpectedError'
5435 $ref: '#/components/responses/UnexpectedError'
5436 '/admin/v1/k8srepos':
5440 summary: Query information about multiple K8s Repos
5441 description: Query information about multiple K8s Repos
5442 operationId: getK8sRepos
5449 $ref: '#/components/schemas/ArrayOfK8sRepoInfo'
5452 $ref: '#/components/schemas/ArrayOfK8sRepoInfo'
5454 $ref: '#/components/responses/BadRequest'
5456 $ref: '#/components/responses/Unauthorized'
5458 $ref: '#/components/responses/Forbidden'
5460 $ref: '#/components/responses/NotFound'
5462 $ref: '#/components/responses/MethodNotAllowed'
5464 $ref: '#/components/responses/NotAcceptable'
5466 $ref: '#/components/responses/Conflict'
5468 $ref: '#/components/responses/UnprocessableEntity'
5470 $ref: '#/components/responses/InternalServerError'
5472 $ref: '#/components/responses/ServiceUnavailable'
5474 $ref: '#/components/responses/UnexpectedError'
5476 $ref: '#/components/responses/UnexpectedError'
5480 summary: Create a new K8s Repo
5481 description: Create a new K8s Repo
5482 operationId: createK8sRepo
5484 $ref: '#/components/requestBodies/CreateK8sRepoRequest'
5487 description: Accepted
5491 $ref: '#/components/schemas/ObjectId_plus_OpId'
5494 $ref: '#/components/schemas/ObjectId_plus_OpId'
5496 $ref: '#/components/responses/BadRequest'
5498 $ref: '#/components/responses/Unauthorized'
5500 $ref: '#/components/responses/Forbidden'
5502 $ref: '#/components/responses/NotFound'
5504 $ref: '#/components/responses/MethodNotAllowed'
5506 $ref: '#/components/responses/NotAcceptable'
5508 $ref: '#/components/responses/Conflict'
5510 $ref: '#/components/responses/UnprocessableEntity'
5512 $ref: '#/components/responses/InternalServerError'
5514 $ref: '#/components/responses/ServiceUnavailable'
5516 $ref: '#/components/responses/UnexpectedError'
5518 $ref: '#/components/responses/UnexpectedError'
5519 '/admin/v1/k8srepos/{k8sRepoId}':
5524 description: K8s Repo ID
5531 summary: Query information about an individual K8s Repo
5532 description: Query information about an individual K8s Repo
5533 operationId: getK8sRepo
5540 $ref: '#/components/schemas/K8sRepoInfo'
5543 $ref: '#/components/schemas/K8sRepoInfo'
5545 $ref: '#/components/responses/BadRequest'
5547 $ref: '#/components/responses/Unauthorized'
5549 $ref: '#/components/responses/Forbidden'
5551 $ref: '#/components/responses/NotFound'
5553 $ref: '#/components/responses/MethodNotAllowed'
5555 $ref: '#/components/responses/NotAcceptable'
5557 $ref: '#/components/responses/Conflict'
5559 $ref: '#/components/responses/UnprocessableEntity'
5561 $ref: '#/components/responses/InternalServerError'
5563 $ref: '#/components/responses/ServiceUnavailable'
5565 $ref: '#/components/responses/UnexpectedError'
5567 $ref: '#/components/responses/UnexpectedError'
5571 summary: Delete a K8s Repo
5572 description: Delete a K8s Repo
5573 operationId: deleteK8sRepo
5576 description: Accepted
5578 $ref: '#/components/responses/BadRequest'
5580 $ref: '#/components/responses/Unauthorized'
5582 $ref: '#/components/responses/Forbidden'
5584 $ref: '#/components/responses/NotFound'
5586 $ref: '#/components/responses/MethodNotAllowed'
5588 $ref: '#/components/responses/NotAcceptable'
5590 $ref: '#/components/responses/Conflict'
5592 $ref: '#/components/responses/UnprocessableEntity'
5594 $ref: '#/components/responses/InternalServerError'
5596 $ref: '#/components/responses/ServiceUnavailable'
5598 $ref: '#/components/responses/UnexpectedError'
5600 $ref: '#/components/responses/UnexpectedError'
5604 description: Find out more about OSM
5605 url: 'https://osm.etsi.org/docs/user-guide/'
5610 description: Bad request. The server cannot process the request due to a client error.
5614 $ref: '#/components/schemas/ProblemDetails'
5616 description: Authorization information is missing or invalid.
5620 $ref: '#/components/schemas/ProblemDetails'
5622 description: Not enough permissions to do this operation.
5626 $ref: '#/components/schemas/ProblemDetails'
5628 description: The specified resource was not found.
5632 $ref: '#/components/schemas/ProblemDetails'
5634 description: This method is not supported for the requested resource.
5638 $ref: '#/components/schemas/ProblemDetails'
5640 description: The requested resource content cannot match the Accept headers sent in the request.
5644 $ref: '#/components/schemas/ProblemDetails'
5646 description: The operation cannot be executed currently, due to a conflict with the state of the resource.
5650 $ref: '#/components/schemas/ProblemDetails'
5651 UnprocessableEntity:
5652 description: The request was well-formed but was unable to be followed due to semantic errors.
5656 $ref: '#/components/schemas/ProblemDetails'
5657 InternalServerError:
5658 description: Internal server error.
5662 $ref: '#/components/schemas/ProblemDetails'
5664 description: Service temporarily unavailable.
5668 $ref: '#/components/schemas/ProblemDetails'
5670 description: Unexpected error.
5674 $ref: '#/components/schemas/ProblemDetails'
5676 description: VNF Descriptor (plaintext)
5680 $ref: '#/components/schemas/VnfDescriptor'
5682 description: VNF Package (compressed)
5686 $ref: '#/components/schemas/VnfPackage'
5688 description: NS Descriptor (plaintext)
5692 $ref: '#/components/schemas/NsDescriptor'
5694 description: NS Package (compressed)
5698 $ref: '#/components/schemas/NsPackage'
5700 description: NetSlice Template (plaintext)
5704 $ref: '#/components/schemas/NetSliceTemplate'
5706 description: NetSlice Package (compressed)
5710 $ref: '#/components/schemas/NetSlicePackage'
5721 # A free list of key:value pairs
5723 additionalProperties: true
5730 CreateNsdInfoRequest:
5731 # A free list of key:value pairs
5733 additionalProperties: true
5734 NsdInfoModifications:
5736 NS Descriptor Information
5737 Only generic fields (id, name, description) are described
5738 For a full specification of the NS Descriptor see:
5739 http://osm-download.etsi.org/ftp/osm-doc/nsd.html
5743 description: NSD Identifier
5746 description: NSD Name
5749 description: NSD Description
5753 NS Descriptor Information
5754 Only generic fields (_id, id, name, description) are described
5755 For a full specification of the NS Descriptor see:
5756 http://osm-download.etsi.org/ftp/osm-doc/nsd.html
5761 Identifier of the onboarded individual NS descriptor
5762 resource. This identifier is allocated by the NFVO.
5767 This identifier, which is allocated by the NSD
5768 designer, identifies the NSD in a globally unique
5769 way. It is copied from the NSD content and shall be
5770 present after the NSD content is on-boarded.
5774 Name of the onboarded NSD. This information is
5775 copied from the NSD content and shall be present
5776 after the NSD content is on-boarded.
5780 Description of the onboarded NSD.
5781 This information is copied from the NSD content.
5789 $ref: '#/components/schemas/NsdInfo'
5805 additionalProperties: true
5815 CreateVnfPkgInfoRequest:
5816 # A free list of key:value pairs
5818 additionalProperties: true
5819 VnfPkgInfoModifications:
5821 VNF Package Information
5822 Only generic fields (id, name, description) are described
5823 For a full specification of the VNF Descriptor see:
5824 http://osm-download.etsi.org/ftp/osm-doc/vnfd.html
5828 description: VNF Package Identifier
5831 description: VNF Package Name
5834 description: VNF Package description
5838 VNF Package Information
5839 Only generic fields (_id, id, name, description) are described
5840 For a full specification of the VNF Descriptor see:
5841 http://osm-download.etsi.org/ftp/osm-doc/vnfd.html
5846 Identifier of the VNF package. This identifier is allocated by the NFVO.
5850 description: VNF Package Identifier
5853 description: VNF Package Name
5856 description: VNF Package description
5864 $ref: '#/components/schemas/VnfPkgInfo'
5866 # Substituted by InstantiateNsRequest
5869 NS Instance Information
5870 Only generic fields (_id, id, name, description) are described
5871 For a full specification of the NS Instance see:
5872 http://osm-download.etsi.org/ftp/osm-doc/nsr.html
5876 description: Identifier of the NS instance.
5880 description: Identifier of the NS instance.
5884 description: Human readable name of the NS instance.
5887 description: Human readable description of the NS instance.
5893 InstantiateNsRequest:
5898 Human-readable name of the NS instance to be created.
5902 Identifier of the NSD that defines the NS instance to be created.
5907 Identifier of the VIM Account where the NS instance shall be created.
5926 additionalParamsForNs:
5928 additionalProperties: true
5929 additionalParamsForVnf:
5938 additionalProperties: true
5939 additionalParamsForVdu:
5948 additionalProperties: true
5952 additionalProperties: false
5953 additionalParamsForKdu:
5962 additionalProperties: true
5966 additionalProperties: false
5970 additionalProperties: false
6009 additionalProperties: false
6024 floating-ip-required:
6028 additionalProperties: false
6032 additionalProperties: false
6071 additionalProperties: false
6085 additionalProperties: false
6087 additionalProperties: false
6095 additionalProperties: false
6096 internal-connection-point:
6109 additionalProperties: False
6114 additionalProperties: false
6119 additionalProperties: false
6138 additionalProperties: true
6146 additionalProperties: true
6154 additionalProperties: false
6155 vnfd-connection-point-ref:
6160 member-vnf-index-ref:
6162 vnfd-connection-point-ref:
6168 - member-vnf-index-ref
6169 - vnfd-connection-point-ref
6171 additionalProperties: false
6175 additionalProperties: false
6181 additionalProperties: false
6200 scaling-group-descriptor:
6204 additionalProperties: true
6205 additionalProperties: true
6206 additionalProperties: true
6212 Timestamp indicating the end time of the NS, i.e. the NS will be terminated
6213 automatically at this timestamp. Cardinality "0" indicates the NS termination
6214 takes place immediately.
6220 $ref: '#/components/schemas/NsInstance'
6221 NSinstanceActionRequest:
6227 $ref: '#/components/schemas/KeyValuePairs'
6242 additionalProperties: false
6243 # CreateNSinstanceContentRequest:
6244 # Substituted by InstantiateNsRequest
6245 CreateNSinstanceContentResponse:
6268 isAutomaticInvocation:
6310 $ref: '#/components/schemas/NsLcmOpOcc'
6313 VNF Instance Information
6314 Only generic fields (_id, id) are described
6315 For a full specification of the VNF Instance see:
6316 http://osm-download.etsi.org/ftp/osm-doc/vnfr.html
6325 ArrayOfVnfInstanceInfo:
6328 $ref: '#/components/schemas/VnfInstanceInfo'
6331 NetSlice Template Information
6332 Only generic fields (_id, id, name) are described
6333 For a full specification of the NetSlice Template see:
6334 http://osm-download.etsi.org/ftp/osm-doc/nst.html
6338 description: NetSlice Template Identifier
6342 description: Human readable NetSlice Template Identifier
6345 description: Human readable name of the NetSlice Template
6350 $ref: '#/components/schemas/NstInfo'
6351 CreateNstInfoRequest:
6352 # A free list of key:value pairs
6354 additionalProperties: true
6361 NstInfoModifications:
6363 NetSlice Template Information
6364 Only generic fields (id, name) are described
6365 For a full specification of the NetSlice Template see:
6366 http://osm-download.etsi.org/ftp/osm-doc/nst.html
6370 description: NST Identifier
6373 description: NST Name
6377 NetSlice Instance Information
6378 Only generic fields (_id, id, name, description) are described
6379 For a full specification of the NetSlice Instance see:
6380 http://osm-download.etsi.org/ftp/osm-doc/nsi.html
6384 description: Identifier of the NetSlice instance.
6388 description: Identifier of the NetSlice instance.
6392 description: Human readable name of the NetSlice instance.
6395 description: Human readable description of the NetSlice instance.
6401 ArrayOfNetSliceInstance:
6404 $ref: '#/components/schemas/NetSliceInstance'
6406 # Substituted by InstantiateNsiRequest
6407 InstantiateNsiRequest:
6412 Human-readable name of the NetSlice instance to be created.
6416 Identifier of the NST that defines the NetSlice instance to be created.
6421 Identifier of the VIM Account where the NetSlice instance shall be created.
6437 additionalParamsForNsi:
6439 additionalProperties: true
6471 additionalParamsForNs:
6473 additionalProperties: true
6474 additionalParamsForVnf:
6483 additionalProperties: true
6484 additionalParamsForVdu:
6493 additionalProperties: true
6497 additionalProperties: false
6498 additionalParamsForKdu:
6507 additionalProperties: true
6511 additionalProperties: false
6515 additionalProperties: false
6554 additionalProperties: false
6569 floating-ip-required:
6573 additionalProperties: false
6577 additionalProperties: false
6616 additionalProperties: false
6630 additionalProperties: false
6632 additionalProperties: false
6640 additionalProperties: false
6641 internal-connection-point:
6654 additionalProperties: False
6659 additionalProperties: false
6664 additionalProperties: false
6683 additionalProperties: true
6691 additionalProperties: true
6699 additionalProperties: false
6700 vnfd-connection-point-ref:
6705 member-vnf-index-ref:
6707 vnfd-connection-point-ref:
6713 - member-vnf-index-ref
6714 - vnfd-connection-point-ref
6716 additionalProperties: false
6720 additionalProperties: false
6722 additionalProperties: false
6741 additionalProperties: true
6744 additionalProperties: false
6750 additionalProperties: false
6751 TerminateNsiRequest:
6756 Timestamp indicating the end time of the NSI, i.e. the NSI will be terminated
6757 automatically at this timestamp. Cardinality "0" indicates the NSI termination
6758 takes place immediately.
6767 $ref: '#/components/schemas/KeyValuePairs'
6776 # CreateNsiContentRequest:
6777 # Substituted by InstantiateNsiRequest
6778 CreateNsiContentResponse:
6801 isAutomaticInvocation:
6848 $ref: '#/components/schemas/NsiLcmOpOcc'
6892 $ref: '#/components/schemas/TokenInfo'
6915 project_role_mappings:
6937 $ref: '#/components/schemas/UserInfo'
6938 ProjectRoleMappings:
6950 additionalProperties: false
6951 ProjectRoleMappingsOpt:
6962 additionalProperties: false
6974 project_role_mappings:
6975 $ref: '#/components/schemas/ProjectRoleMappings'
6979 additionalProperties: false
6986 additionalProperties: true
6989 Array edition keys must start with '$'
6990 and follow the syntax defined in: https://osm.etsi.org/wikipub/index.php/NBI_API_Description
7000 - $ref: '#/components/schemas/ShortNameList'
7001 - $ref: '#/components/schemas/ArrayEditionSchema'
7002 project_role_mappings:
7003 $ref: '#/components/schemas/ProjectRoleMappings'
7004 add_project_role_mappings:
7005 $ref: '#/components/schemas/ProjectRoleMappings'
7006 remove_project_role_mappings:
7007 $ref: '#/components/schemas/ProjectRoleMappingsOpt'
7047 additionalProperties: false
7087 additionalProperties: false
7097 $ref: '#/components/schemas/QuotasInfo'
7101 $ref: '#/components/schemas/ProjectInfo'
7102 CreateProjectRequest:
7110 $ref: '#/components/schemas/QuotasInfo'
7113 additionalProperties: false
7122 $ref: '#/components/schemas/EditQuotasInfo'
7123 additionalProperties: false
7126 additionalProperties:
7130 Permissions keys must follow the syntax 'main_topic[:subtopic[:id[:component|action|etc]]]'
7131 Permission values are either true or false
7132 EditPermissionsInfo:
7134 additionalProperties:
7138 Permissions keys must follow the syntax 'main_topic[:subtopic[:id[:component|action|etc]]]'
7139 Permission values are either true, false, or null
7149 $ref: '#/components/schemas/PermissionsInfo'
7153 $ref: '#/components/schemas/RoleInfo'
7160 $ref: '#/components/schemas/PermissionsInfo'
7163 additionalProperties: false
7170 $ref: '#/components/schemas/EditPermissionsInfo'
7171 additionalProperties: false
7202 $ref: '#/components/schemas/VimType'
7214 additionalProperties: true
7218 $ref: '#/components/schemas/VimInfo'
7236 $ref: '#/components/schemas/VimType'
7248 additionalProperties: true
7256 additionalProperties: false
7269 $ref: '#/components/schemas/VimType'
7281 additionalProperties: true
7282 additionalProperties: false
7324 $ref: '#/components/schemas/WimType'
7334 additionalProperties: true
7338 $ref: '#/components/schemas/WimInfo'
7354 $ref: '#/components/schemas/WimType'
7364 additionalProperties: true
7369 additionalProperties: false
7390 additionalProperties: true
7391 additionalProperties: false
7430 - $ref: '#/components/schemas/SdnExtraProperties'
7431 - $ref: '#/components/schemas/SdnBasicProperties'
7435 $ref: '#/components/schemas/SdnInfo'
7438 - $ref: '#/components/schemas/SdnBasicProperties'
7445 additionalProperties: false
7448 - $ref: '#/components/schemas/SdnBasicProperties'
7449 additionalProperties: false
7505 additionalProperties: false
7529 $ref: '#/components/schemas/PduInterfaces'
7533 $ref: '#/components/schemas/PduInfo'
7554 $ref: '#/components/schemas/PduInterfaces'
7559 additionalProperties: false
7580 $ref: '#/components/schemas/PduInterfaces'
7581 additionalProperties: false
7586 additionalProperties: true
7604 additionalProperties: true
7611 $ref: '#/components/schemas/K8sClusterNetList'
7618 ArrayOfK8sClusterInfo:
7621 $ref: '#/components/schemas/K8sClusterInfo'
7622 CreateK8sClusterRequest:
7636 additionalProperties: true
7643 $ref: '#/components/schemas/K8sClusterNetList'
7656 additionalProperties: false
7657 EditK8sClusterRequest:
7666 additionalProperties: true
7673 $ref: '#/components/schemas/K8sClusterNetList'
7680 additionalProperties: false
7697 $ref: '#/components/schemas/K8sRepoType'
7704 $ref: '#/components/schemas/K8sRepoInfo'
7705 CreateK8sRepoRequest:
7713 $ref: '#/components/schemas/K8sRepoType'
7721 additionalProperties: false
7725 CreateNsdInfoRequest:
7729 $ref: '#/components/schemas/CreateNsdInfoRequest'
7732 $ref: '#/components/schemas/CreateNsdInfoRequest'
7733 NsdInfoModifications:
7737 $ref: '#/components/schemas/NsdInfoModifications'
7740 $ref: '#/components/schemas/NsdInfoModifications'
7745 $ref: '#/components/schemas/NsDescriptor'
7750 $ref: '#/components/schemas/NsPackage'
7751 CreateVnfPkgInfoRequest:
7755 $ref: '#/components/schemas/CreateVnfPkgInfoRequest'
7758 $ref: '#/components/schemas/CreateVnfPkgInfoRequest'
7759 VnfPkgInfoModifications:
7763 $ref: '#/components/schemas/VnfPkgInfoModifications'
7766 $ref: '#/components/schemas/VnfPkgInfoModifications'
7771 $ref: '#/components/schemas/VnfPackage'
7776 $ref: '#/components/schemas/VnfDescriptor'
7778 # Substituted by InstantiateNsRequest
7779 InstantiateNsRequest:
7783 $ref: '#/components/schemas/InstantiateNsRequest'
7786 $ref: '#/components/schemas/InstantiateNsRequest'
7791 $ref: '#/components/schemas/ScaleNsRequest'
7794 $ref: '#/components/schemas/ScaleNsRequest'
7799 $ref: '#/components/schemas/TerminateNsRequest'
7802 $ref: '#/components/schemas/TerminateNsRequest'
7803 # CreateNSinstanceContentRequest:
7804 # Substituted by InstantiateNsRequest
7805 CreateNstInfoRequest:
7809 $ref: '#/components/schemas/CreateNstInfoRequest'
7812 $ref: '#/components/schemas/CreateNstInfoRequest'
7817 $ref: '#/components/schemas/NetSliceTemplate'
7822 $ref: '#/components/schemas/NetSlicePackage'
7823 NstInfoModifications:
7827 $ref: '#/components/schemas/NstInfoModifications'
7830 $ref: '#/components/schemas/NstInfoModifications'
7832 # Substituted by InstantiateNsiRequest
7833 InstantiateNsiRequest:
7837 $ref: '#/components/schemas/InstantiateNsiRequest'
7840 $ref: '#/components/schemas/InstantiateNsiRequest'
7841 TerminateNsiRequest:
7845 $ref: '#/components/schemas/TerminateNsiRequest'
7848 $ref: '#/components/schemas/TerminateNsiRequest'
7853 $ref: '#/components/schemas/NsiActionRequest'
7856 $ref: '#/components/schemas/NsiActionRequest'
7857 # CreateNsiContentRequest:
7858 # Substituted by InstantiateNsiRequest
7863 $ref: '#/components/schemas/CreateTokenRequest'
7866 $ref: '#/components/schemas/CreateTokenRequest'
7871 $ref: '#/components/schemas/CreateUserRequest'
7874 $ref: '#/components/schemas/CreateUserRequest'
7879 $ref: '#/components/schemas/EditUserRequest'
7882 $ref: '#/components/schemas/EditUserRequest'
7883 CreateProjectRequest:
7887 $ref: '#/components/schemas/CreateProjectRequest'
7890 $ref: '#/components/schemas/CreateProjectRequest'
7895 $ref: '#/components/schemas/EditProjectRequest'
7898 $ref: '#/components/schemas/EditProjectRequest'
7903 $ref: '#/components/schemas/CreateRoleRequest'
7906 $ref: '#/components/schemas/CreateRoleRequest'
7911 $ref: '#/components/schemas/EditRoleRequest'
7914 $ref: '#/components/schemas/EditRoleRequest'
7919 $ref: '#/components/schemas/CreateVimRequest'
7922 $ref: '#/components/schemas/CreateVimRequest'
7927 $ref: '#/components/schemas/EditVimRequest'
7930 $ref: '#/components/schemas/EditVimRequest'
7935 $ref: '#/components/schemas/CreateWimRequest'
7938 $ref: '#/components/schemas/CreateWimRequest'
7943 $ref: '#/components/schemas/EditWimRequest'
7946 $ref: '#/components/schemas/EditWimRequest'
7951 $ref: '#/components/schemas/CreateSdnRequest'
7954 $ref: '#/components/schemas/CreateSdnRequest'
7959 $ref: '#/components/schemas/EditSdnRequest'
7962 $ref: '#/components/schemas/EditSdnRequest'
7967 $ref: '#/components/schemas/CreatePduRequest'
7970 $ref: '#/components/schemas/CreatePduRequest'
7975 $ref: '#/components/schemas/EditPduRequest'
7978 $ref: '#/components/schemas/EditPduRequest'
7979 CreateK8sClusterRequest:
7983 $ref: '#/components/schemas/CreateK8sClusterRequest'
7986 $ref: '#/components/schemas/CreateK8sClusterRequest'
7987 EditK8sClusterRequest:
7991 $ref: '#/components/schemas/EditK8sClusterRequest'
7994 $ref: '#/components/schemas/EditK8sClusterRequest'
7995 CreateK8sRepoRequest:
7999 $ref: '#/components/schemas/CreateK8sRepoRequest'
8002 $ref: '#/components/schemas/CreateK8sRepoRequest'
8003 # END REQUEST BODIES