4 - description: OSM NB API
5 url: 'https://osm.etsi.org/nbapi/v1.0.0'
9 This is Open Source MANO Northbound API featuring ETSI NFV SOL005.
10 For more information on OSM, you can visit [http://osm.etsi.org](http://osm.etsi.org).
11 You can send us your comments and questions to OSM_TECH@list.etsi.org
12 or join the [OpenSourceMANO Slack Workplace](https://join.slack.com/t/opensourcemano/shared_invite/enQtMzQ3MzYzNTQ0NDIyLWVkNTE4ZjZjNWI0ZTQyN2VhOTI1MjViMzU1NWYwMWM3ODI4NTQyY2VlODA2ZjczMWIyYTFkZWNiZmFkM2M2ZDk)
14 title: OSM NB API featuring ETSI NFV SOL005
16 email: OSM_TECH@list.etsi.org
19 url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
22 - name: 'VNF packages'
23 description: Management operations of VNF descriptors and packages
25 description: Management operations of NS descriptors and packages
26 - name: 'NS instances'
27 description: Management operations of NS instances
28 - name: 'NetSlice templates'
29 description: Management operations of NetSlice Templates
30 - name: 'NetSlice instances'
31 description: Management operations of NetSlice Instances
32 - name: 'NS Performance Management'
33 description: Management operations related to Performance Mangement of NS instances
34 - name: 'Physical Data Units (PDU)'
35 description: Management operations of PDUs
36 - name: 'Authentication'
37 description: Authentication operations
39 description: Management operations of users, projects and roles
40 - name: 'Infrastructure'
41 description: Management operations of VIM, VIM accounts, WIM and SDN controllers
42 - name: 'Repositories'
43 description: Management operations of repositories
45 description: Management operations of Administration items
53 '/nsd/v1/ns_descriptors':
57 summary: Query information about multiple NS descriptor resources
58 description: Query information about multiple NS descriptor resources
66 $ref: '#/components/schemas/ArrayOfNsdInfo'
69 $ref: '#/components/schemas/ArrayOfNsdInfo'
71 $ref: '#/components/responses/BadRequest'
73 $ref: '#/components/responses/Unauthorized'
75 $ref: '#/components/responses/Forbidden'
77 $ref: '#/components/responses/NotFound'
79 $ref: '#/components/responses/MethodNotAllowed'
81 $ref: '#/components/responses/NotAcceptable'
83 $ref: '#/components/responses/Conflict'
85 $ref: '#/components/responses/UnprocessableEntity'
87 $ref: '#/components/responses/InternalServerError'
89 $ref: '#/components/responses/ServiceUnavailable'
91 $ref: '#/components/responses/UnexpectedError'
93 $ref: '#/components/responses/UnexpectedError'
97 summary: Create a new NS descriptor resource
98 description: Create a new NS descriptor resource
101 $ref: '#/components/requestBodies/CreateNsdInfoRequest'
113 $ref: '#/components/schemas/ObjectId'
116 $ref: '#/components/schemas/ObjectId'
118 $ref: '#/components/responses/BadRequest'
120 $ref: '#/components/responses/Unauthorized'
122 $ref: '#/components/responses/Forbidden'
124 $ref: '#/components/responses/NotFound'
126 $ref: '#/components/responses/MethodNotAllowed'
128 $ref: '#/components/responses/NotAcceptable'
130 $ref: '#/components/responses/Conflict'
132 $ref: '#/components/responses/UnprocessableEntity'
134 $ref: '#/components/responses/InternalServerError'
136 $ref: '#/components/responses/ServiceUnavailable'
138 $ref: '#/components/responses/UnexpectedError'
140 $ref: '#/components/responses/UnexpectedError'
141 '/nsd/v1/ns_descriptors/{nsdInfoId}':
146 description: NSD Info ID
152 summary: Read information about an individual NS descriptor resource
153 description: Read information about an individual NS descriptor resource
161 $ref: '#/components/schemas/NsdInfo'
164 $ref: '#/components/schemas/NsdInfo'
166 $ref: '#/components/responses/BadRequest'
168 $ref: '#/components/responses/Unauthorized'
170 $ref: '#/components/responses/Forbidden'
172 $ref: '#/components/responses/NotFound'
174 $ref: '#/components/responses/MethodNotAllowed'
176 $ref: '#/components/responses/NotAcceptable'
178 $ref: '#/components/responses/Conflict'
180 $ref: '#/components/responses/UnprocessableEntity'
182 $ref: '#/components/responses/InternalServerError'
184 $ref: '#/components/responses/ServiceUnavailable'
186 $ref: '#/components/responses/UnexpectedError'
188 $ref: '#/components/responses/UnexpectedError'
192 summary: Delete an individual NS descriptor resource
193 description: Delete an individual NS descriptor resource
194 operationId: deleteNSD
197 description: No Content
199 $ref: '#/components/responses/BadRequest'
201 $ref: '#/components/responses/Unauthorized'
203 $ref: '#/components/responses/Forbidden'
205 $ref: '#/components/responses/NotFound'
207 $ref: '#/components/responses/MethodNotAllowed'
209 $ref: '#/components/responses/NotAcceptable'
211 $ref: '#/components/responses/Conflict'
213 $ref: '#/components/responses/UnprocessableEntity'
215 $ref: '#/components/responses/InternalServerError'
217 $ref: '#/components/responses/ServiceUnavailable'
219 $ref: '#/components/responses/UnexpectedError'
221 $ref: '#/components/responses/UnexpectedError'
225 summary: Modify the data of an individual NS descriptor resource
226 description: Modify the data of an individual NS descriptor resource
227 operationId: updateNSD
229 $ref: '#/components/requestBodies/NsdInfoModifications'
232 description: No Content
234 $ref: '#/components/responses/BadRequest'
236 $ref: '#/components/responses/Unauthorized'
238 $ref: '#/components/responses/Forbidden'
240 $ref: '#/components/responses/NotFound'
242 $ref: '#/components/responses/MethodNotAllowed'
244 $ref: '#/components/responses/NotAcceptable'
246 $ref: '#/components/responses/Conflict'
248 $ref: '#/components/responses/UnprocessableEntity'
250 $ref: '#/components/responses/InternalServerError'
252 $ref: '#/components/responses/ServiceUnavailable'
254 $ref: '#/components/responses/UnexpectedError'
256 $ref: '#/components/responses/UnexpectedError'
257 '/nsd/v1/ns_descriptors/{nsdInfoId}/nsd_content':
262 description: NSD Info ID
268 summary: Fetch the content of a NSD
269 description: Fetch the content of a NSD
270 operationId: getNSDcontent
277 $ref: '#/components/schemas/NsPackage'
279 description: Partial Content
287 $ref: '#/components/schemas/NsPackage'
289 $ref: '#/components/responses/BadRequest'
291 $ref: '#/components/responses/Unauthorized'
293 $ref: '#/components/responses/Forbidden'
295 $ref: '#/components/responses/NotFound'
297 $ref: '#/components/responses/MethodNotAllowed'
299 $ref: '#/components/responses/NotAcceptable'
301 $ref: '#/components/responses/Conflict'
303 $ref: '#/components/responses/UnprocessableEntity'
305 $ref: '#/components/responses/InternalServerError'
307 $ref: '#/components/responses/ServiceUnavailable'
309 $ref: '#/components/responses/UnexpectedError'
311 $ref: '#/components/responses/UnexpectedError'
315 summary: Upload the content of a NSD
316 description: Upload the content of a NSD
317 operationId: updateNSDcontent
319 $ref: '#/components/requestBodies/NsPackage'
322 description: Accepted
324 description: No Content
326 $ref: '#/components/responses/BadRequest'
328 $ref: '#/components/responses/Unauthorized'
330 $ref: '#/components/responses/Forbidden'
332 $ref: '#/components/responses/NotFound'
334 $ref: '#/components/responses/MethodNotAllowed'
336 $ref: '#/components/responses/NotAcceptable'
338 $ref: '#/components/responses/Conflict'
340 $ref: '#/components/responses/UnprocessableEntity'
342 $ref: '#/components/responses/InternalServerError'
344 $ref: '#/components/responses/ServiceUnavailable'
346 $ref: '#/components/responses/UnexpectedError'
348 $ref: '#/components/responses/UnexpectedError'
349 '/nsd/v1/ns_descriptors/{nsdInfoId}/artifacts/{artifactPath}':
354 description: NS Package ID
360 description: Artifact Path
366 summary: Fetch individual NS package artifact
367 description: Fetch individual NS package artifact
368 operationId: getNsPkgArtifact
373 application/octet-stream:
378 description: Partial Content
384 application/octet-stream:
389 $ref: '#/components/responses/BadRequest'
391 $ref: '#/components/responses/Unauthorized'
393 $ref: '#/components/responses/Forbidden'
395 $ref: '#/components/responses/NotFound'
397 $ref: '#/components/responses/MethodNotAllowed'
399 $ref: '#/components/responses/NotAcceptable'
401 $ref: '#/components/responses/Conflict'
403 $ref: '#/components/responses/UnprocessableEntity'
405 $ref: '#/components/responses/InternalServerError'
407 $ref: '#/components/responses/ServiceUnavailable'
409 $ref: '#/components/responses/UnexpectedError'
411 $ref: '#/components/responses/UnexpectedError'
412 '/nsd/v1/ns_descriptors/{nsdInfoId}/nsd':
417 description: NS Package ID
423 summary: Read NSD of an on-boarded NS package
424 description: Read NSD of an on-boarded NS package
425 operationId: getNsPkgNsd
432 $ref: '#/components/schemas/NsDescriptor'
434 $ref: '#/components/responses/BadRequest'
436 $ref: '#/components/responses/Unauthorized'
438 $ref: '#/components/responses/Forbidden'
440 $ref: '#/components/responses/NotFound'
442 $ref: '#/components/responses/MethodNotAllowed'
444 $ref: '#/components/responses/NotAcceptable'
446 $ref: '#/components/responses/Conflict'
448 $ref: '#/components/responses/UnprocessableEntity'
450 $ref: '#/components/responses/InternalServerError'
452 $ref: '#/components/responses/ServiceUnavailable'
454 $ref: '#/components/responses/UnexpectedError'
456 $ref: '#/components/responses/UnexpectedError'
457 '/nsd/v1/ns_descriptors_content':
461 summary: Upload a NS package by providing the content of the NS package
462 description: Upload a NS package by providing the content of the NS package
463 operationId: uploadNsPkgsContent
468 $ref: '#/components/schemas/NsPackage'
480 $ref: '#/components/schemas/ObjectId'
483 $ref: '#/components/schemas/ObjectId'
485 description: Accepted
487 description: No Content
489 $ref: '#/components/responses/BadRequest'
491 $ref: '#/components/responses/Unauthorized'
493 $ref: '#/components/responses/Forbidden'
495 $ref: '#/components/responses/NotFound'
497 $ref: '#/components/responses/MethodNotAllowed'
499 $ref: '#/components/responses/NotAcceptable'
501 $ref: '#/components/responses/Conflict'
503 $ref: '#/components/responses/UnprocessableEntity'
505 $ref: '#/components/responses/InternalServerError'
507 $ref: '#/components/responses/ServiceUnavailable'
509 $ref: '#/components/responses/UnexpectedError'
511 $ref: '#/components/responses/UnexpectedError'
515 summary: Query information about multiple NS package resources
516 description: Query information about multiple NS package resources
517 operationId: getNsPkgsContent
524 $ref: '#/components/schemas/ArrayOfNsdInfo'
527 $ref: '#/components/schemas/ArrayOfNsdInfo'
529 description: Partial Content
535 application/octet-stream:
540 $ref: '#/components/responses/BadRequest'
542 $ref: '#/components/responses/Unauthorized'
544 $ref: '#/components/responses/Forbidden'
546 $ref: '#/components/responses/NotFound'
548 $ref: '#/components/responses/MethodNotAllowed'
550 $ref: '#/components/responses/NotAcceptable'
552 $ref: '#/components/responses/Conflict'
554 $ref: '#/components/responses/UnprocessableEntity'
556 $ref: '#/components/responses/InternalServerError'
558 $ref: '#/components/responses/ServiceUnavailable'
560 $ref: '#/components/responses/UnexpectedError'
562 $ref: '#/components/responses/UnexpectedError'
563 '/nsd/v1/ns_descriptors_content/{nsdInfoId}':
568 description: NS Package ID
574 summary: Read information about an individual NS package resource
575 description: Read information about an individual NS package resource
576 operationId: getNsPkgsIdContent
583 $ref: '#/components/schemas/NsdInfo'
586 $ref: '#/components/schemas/NsdInfo'
588 $ref: '#/components/responses/BadRequest'
590 $ref: '#/components/responses/Unauthorized'
592 $ref: '#/components/responses/Forbidden'
594 $ref: '#/components/responses/NotFound'
596 $ref: '#/components/responses/MethodNotAllowed'
598 $ref: '#/components/responses/NotAcceptable'
600 $ref: '#/components/responses/Conflict'
602 $ref: '#/components/responses/UnprocessableEntity'
604 $ref: '#/components/responses/InternalServerError'
606 $ref: '#/components/responses/ServiceUnavailable'
608 $ref: '#/components/responses/UnexpectedError'
610 $ref: '#/components/responses/UnexpectedError'
614 summary: Modify an individual NS package resource
615 description: Modify an individual NS package resource
616 operationId: updateNsPkgsIdContent
618 $ref: '#/components/requestBodies/NsdInfoModifications'
621 description: No Content
623 $ref: '#/components/responses/BadRequest'
625 $ref: '#/components/responses/Unauthorized'
627 $ref: '#/components/responses/Forbidden'
629 $ref: '#/components/responses/NotFound'
631 $ref: '#/components/responses/MethodNotAllowed'
633 $ref: '#/components/responses/NotAcceptable'
635 $ref: '#/components/responses/Conflict'
637 $ref: '#/components/responses/UnprocessableEntity'
639 $ref: '#/components/responses/InternalServerError'
641 $ref: '#/components/responses/ServiceUnavailable'
643 $ref: '#/components/responses/UnexpectedError'
645 $ref: '#/components/responses/UnexpectedError'
649 summary: Delete an individual NS package resource
650 description: Delete an individual NS package resource
651 operationId: deleteNSPkgsIdContent
654 description: No Content
656 $ref: '#/components/responses/BadRequest'
658 $ref: '#/components/responses/Unauthorized'
660 $ref: '#/components/responses/Forbidden'
662 $ref: '#/components/responses/NotFound'
664 $ref: '#/components/responses/MethodNotAllowed'
666 $ref: '#/components/responses/NotAcceptable'
668 $ref: '#/components/responses/Conflict'
670 $ref: '#/components/responses/UnprocessableEntity'
672 $ref: '#/components/responses/InternalServerError'
674 $ref: '#/components/responses/ServiceUnavailable'
676 $ref: '#/components/responses/UnexpectedError'
678 $ref: '#/components/responses/UnexpectedError'
682 '/vnfpkgm/v1/vnf_packages':
686 summary: Query information about multiple VNF package resources
687 description: Query information about multiple VNF package resources
688 operationId: getVnfPkgs
695 $ref: '#/components/schemas/ArrayOfVnfPkgInfo'
698 $ref: '#/components/schemas/ArrayOfVnfPkgInfo'
700 $ref: '#/components/responses/BadRequest'
702 $ref: '#/components/responses/Unauthorized'
704 $ref: '#/components/responses/Forbidden'
706 $ref: '#/components/responses/NotFound'
708 $ref: '#/components/responses/MethodNotAllowed'
710 $ref: '#/components/responses/NotAcceptable'
712 $ref: '#/components/responses/Conflict'
714 $ref: '#/components/responses/UnprocessableEntity'
716 $ref: '#/components/responses/InternalServerError'
718 $ref: '#/components/responses/ServiceUnavailable'
720 $ref: '#/components/responses/UnexpectedError'
722 $ref: '#/components/responses/UnexpectedError'
726 summary: Create a new VNF package resource
727 description: Create a new VNF package resource
728 operationId: addVnfPkg
730 $ref: '#/components/requestBodies/CreateVnfPkgInfoRequest'
742 $ref: '#/components/schemas/ObjectId'
745 $ref: '#/components/schemas/ObjectId'
747 $ref: '#/components/responses/BadRequest'
749 $ref: '#/components/responses/Unauthorized'
751 $ref: '#/components/responses/Forbidden'
753 $ref: '#/components/responses/NotFound'
755 $ref: '#/components/responses/MethodNotAllowed'
757 $ref: '#/components/responses/NotAcceptable'
759 $ref: '#/components/responses/Conflict'
761 $ref: '#/components/responses/UnprocessableEntity'
763 $ref: '#/components/responses/InternalServerError'
765 $ref: '#/components/responses/ServiceUnavailable'
767 $ref: '#/components/responses/UnexpectedError'
769 $ref: '#/components/responses/UnexpectedError'
770 '/vnfpkgm/v1/vnf_packages/{vnfPkgId}':
775 description: VNF Package ID
781 summary: Read information about an individual VNF package resource
782 description: Read information about an individual VNF package resource
783 operationId: getVnfPkg
790 $ref: '#/components/schemas/VnfPkgInfo'
793 $ref: '#/components/schemas/VnfPkgInfo'
795 $ref: '#/components/responses/BadRequest'
797 $ref: '#/components/responses/Unauthorized'
799 $ref: '#/components/responses/Forbidden'
801 $ref: '#/components/responses/NotFound'
803 $ref: '#/components/responses/MethodNotAllowed'
805 $ref: '#/components/responses/NotAcceptable'
807 $ref: '#/components/responses/Conflict'
809 $ref: '#/components/responses/UnprocessableEntity'
811 $ref: '#/components/responses/InternalServerError'
813 $ref: '#/components/responses/ServiceUnavailable'
815 $ref: '#/components/responses/UnexpectedError'
817 $ref: '#/components/responses/UnexpectedError'
821 summary: Delete an individual VNF package resource
822 description: Delete an individual VNF package resource
823 operationId: deleteVnfPkg
826 description: No Content
828 $ref: '#/components/responses/BadRequest'
830 $ref: '#/components/responses/Unauthorized'
832 $ref: '#/components/responses/Forbidden'
834 $ref: '#/components/responses/NotFound'
836 $ref: '#/components/responses/MethodNotAllowed'
838 $ref: '#/components/responses/NotAcceptable'
840 $ref: '#/components/responses/Conflict'
842 $ref: '#/components/responses/UnprocessableEntity'
844 $ref: '#/components/responses/InternalServerError'
846 $ref: '#/components/responses/ServiceUnavailable'
848 $ref: '#/components/responses/UnexpectedError'
850 $ref: '#/components/responses/UnexpectedError'
854 summary: Modify an individual VNF package resource
855 description: Modify an individual VNF package resource
856 operationId: updateVnfPkg
858 $ref: '#/components/requestBodies/VnfPkgInfoModifications'
861 description: No Content
863 $ref: '#/components/responses/BadRequest'
865 $ref: '#/components/responses/Unauthorized'
867 $ref: '#/components/responses/Forbidden'
869 $ref: '#/components/responses/NotFound'
871 $ref: '#/components/responses/MethodNotAllowed'
873 $ref: '#/components/responses/NotAcceptable'
875 $ref: '#/components/responses/Conflict'
877 $ref: '#/components/responses/UnprocessableEntity'
879 $ref: '#/components/responses/InternalServerError'
881 $ref: '#/components/responses/ServiceUnavailable'
883 $ref: '#/components/responses/UnexpectedError'
885 $ref: '#/components/responses/UnexpectedError'
886 '/vnfpkgm/v1/vnf_packages/{vnfPkgId}/vnfd':
891 description: VNF Package ID
897 summary: Read VNFD of an on-boarded VNF package
898 description: Read VNFD of an on-boarded VNF package
899 operationId: getVnfPkgVnfd
906 $ref: '#/components/schemas/VnfDescriptor'
908 $ref: '#/components/responses/BadRequest'
910 $ref: '#/components/responses/Unauthorized'
912 $ref: '#/components/responses/Forbidden'
914 $ref: '#/components/responses/NotFound'
916 $ref: '#/components/responses/MethodNotAllowed'
918 $ref: '#/components/responses/NotAcceptable'
920 $ref: '#/components/responses/Conflict'
922 $ref: '#/components/responses/UnprocessableEntity'
924 $ref: '#/components/responses/InternalServerError'
926 $ref: '#/components/responses/ServiceUnavailable'
928 $ref: '#/components/responses/UnexpectedError'
930 $ref: '#/components/responses/UnexpectedError'
931 '/vnfpkgm/v1/vnf_packages/{vnfPkgId}/package_content':
936 description: VNF Package ID
942 summary: Fetch an on-boarded VNF package
943 description: Fetch an on-boarded VNF package
944 operationId: getVnfPkgContent
951 $ref: '#/components/schemas/VnfPackage'
953 description: Partial Content
961 $ref: '#/components/schemas/VnfPackage'
963 $ref: '#/components/responses/BadRequest'
965 $ref: '#/components/responses/Unauthorized'
967 $ref: '#/components/responses/Forbidden'
969 $ref: '#/components/responses/NotFound'
971 $ref: '#/components/responses/MethodNotAllowed'
973 $ref: '#/components/responses/NotAcceptable'
975 $ref: '#/components/responses/Conflict'
977 $ref: '#/components/responses/UnprocessableEntity'
979 $ref: '#/components/responses/InternalServerError'
981 $ref: '#/components/responses/ServiceUnavailable'
983 $ref: '#/components/responses/UnexpectedError'
985 $ref: '#/components/responses/UnexpectedError'
989 summary: Upload a VNF package by providing the content of the VNF package
990 description: Upload a VNF package by providing the content of the VNF package
991 operationId: uploadVnfPkgContent
996 $ref: '#/components/schemas/VnfPackage'
999 description: Accepted
1001 description: No Content
1003 $ref: '#/components/responses/BadRequest'
1005 $ref: '#/components/responses/Unauthorized'
1007 $ref: '#/components/responses/Forbidden'
1009 $ref: '#/components/responses/NotFound'
1011 $ref: '#/components/responses/MethodNotAllowed'
1013 $ref: '#/components/responses/NotAcceptable'
1015 $ref: '#/components/responses/Conflict'
1017 $ref: '#/components/responses/UnprocessableEntity'
1019 $ref: '#/components/responses/InternalServerError'
1021 $ref: '#/components/responses/ServiceUnavailable'
1023 $ref: '#/components/responses/UnexpectedError'
1025 $ref: '#/components/responses/UnexpectedError'
1026 '/vnfpkgm/v1/vnf_packages/{vnfPkgId}/artifacts/{artifactPath}':
1031 description: VNF Package ID
1034 - name: artifactPath
1037 description: Artifact Path
1043 summary: Fetch individual VNF package artifact
1044 description: Fetch individual VNF package artifact
1045 operationId: getVnfPkgArtifact
1050 application/octet-stream:
1055 description: Partial Content
1061 application/octet-stream:
1066 $ref: '#/components/responses/BadRequest'
1068 $ref: '#/components/responses/Unauthorized'
1070 $ref: '#/components/responses/Forbidden'
1072 $ref: '#/components/responses/NotFound'
1074 $ref: '#/components/responses/MethodNotAllowed'
1076 $ref: '#/components/responses/NotAcceptable'
1078 $ref: '#/components/responses/Conflict'
1080 $ref: '#/components/responses/UnprocessableEntity'
1082 $ref: '#/components/responses/InternalServerError'
1084 $ref: '#/components/responses/ServiceUnavailable'
1086 $ref: '#/components/responses/UnexpectedError'
1088 $ref: '#/components/responses/UnexpectedError'
1089 '/vnfpkgm/v1/vnf_packages_content':
1093 summary: Upload a VNF package by providing the content of the VNF package
1094 description: Upload a VNF package by providing the content of the VNF package
1095 operationId: uploadVnfPkgsContent
1100 $ref: '#/components/schemas/VnfPackage'
1103 description: Created
1112 $ref: '#/components/schemas/ObjectId'
1115 $ref: '#/components/schemas/ObjectId'
1117 description: Accepted
1119 description: No Content
1121 $ref: '#/components/responses/BadRequest'
1123 $ref: '#/components/responses/Unauthorized'
1125 $ref: '#/components/responses/Forbidden'
1127 $ref: '#/components/responses/NotFound'
1129 $ref: '#/components/responses/MethodNotAllowed'
1131 $ref: '#/components/responses/NotAcceptable'
1133 $ref: '#/components/responses/Conflict'
1135 $ref: '#/components/responses/UnprocessableEntity'
1137 $ref: '#/components/responses/InternalServerError'
1139 $ref: '#/components/responses/ServiceUnavailable'
1141 $ref: '#/components/responses/UnexpectedError'
1143 $ref: '#/components/responses/UnexpectedError'
1147 summary: Query information about multiple VNF package resources
1148 description: Query information about multiple VNF package resources
1149 operationId: getVnfPkgsContent
1156 $ref: '#/components/schemas/ArrayOfVnfPkgInfo'
1159 $ref: '#/components/schemas/ArrayOfVnfPkgInfo'
1161 description: Partial Content
1167 application/octet-stream:
1172 $ref: '#/components/responses/BadRequest'
1174 $ref: '#/components/responses/Unauthorized'
1176 $ref: '#/components/responses/Forbidden'
1178 $ref: '#/components/responses/NotFound'
1180 $ref: '#/components/responses/MethodNotAllowed'
1182 $ref: '#/components/responses/NotAcceptable'
1184 $ref: '#/components/responses/Conflict'
1186 $ref: '#/components/responses/UnprocessableEntity'
1188 $ref: '#/components/responses/InternalServerError'
1190 $ref: '#/components/responses/ServiceUnavailable'
1192 $ref: '#/components/responses/UnexpectedError'
1194 $ref: '#/components/responses/UnexpectedError'
1195 '/vnfpkgm/v1/vnf_packages_content/{packageContentId}':
1197 - name: packageContentId
1200 description: VNF Package Content ID
1206 summary: Read information about an individual VNF package resource
1207 description: Read information about an individual VNF package resource
1208 operationId: getVnfPkgsIdContent
1215 $ref: '#/components/schemas/VnfPkgInfo'
1218 $ref: '#/components/schemas/VnfPkgInfo'
1220 $ref: '#/components/responses/BadRequest'
1222 $ref: '#/components/responses/Unauthorized'
1224 $ref: '#/components/responses/Forbidden'
1226 $ref: '#/components/responses/NotFound'
1228 $ref: '#/components/responses/MethodNotAllowed'
1230 $ref: '#/components/responses/NotAcceptable'
1232 $ref: '#/components/responses/Conflict'
1234 $ref: '#/components/responses/UnprocessableEntity'
1236 $ref: '#/components/responses/InternalServerError'
1238 $ref: '#/components/responses/ServiceUnavailable'
1240 $ref: '#/components/responses/UnexpectedError'
1242 $ref: '#/components/responses/UnexpectedError'
1246 summary: Modify an individual VNF package resource
1247 description: Modify an individual VNF package resource
1248 operationId: updateVnfPkgsIdContent
1250 $ref: '#/components/requestBodies/VnfPkgInfoModifications'
1253 description: No Content
1255 $ref: '#/components/responses/BadRequest'
1257 $ref: '#/components/responses/Unauthorized'
1259 $ref: '#/components/responses/Forbidden'
1261 $ref: '#/components/responses/NotFound'
1263 $ref: '#/components/responses/MethodNotAllowed'
1265 $ref: '#/components/responses/NotAcceptable'
1267 $ref: '#/components/responses/Conflict'
1269 $ref: '#/components/responses/UnprocessableEntity'
1271 $ref: '#/components/responses/InternalServerError'
1273 $ref: '#/components/responses/ServiceUnavailable'
1275 $ref: '#/components/responses/UnexpectedError'
1277 $ref: '#/components/responses/UnexpectedError'
1281 summary: Delete an individual VNF package resource
1282 description: Delete an individual VNF package resource
1283 operationId: deleteVnfPkgsIdContent
1286 description: No Content
1288 $ref: '#/components/responses/BadRequest'
1290 $ref: '#/components/responses/Unauthorized'
1292 $ref: '#/components/responses/Forbidden'
1294 $ref: '#/components/responses/NotFound'
1296 $ref: '#/components/responses/MethodNotAllowed'
1298 $ref: '#/components/responses/NotAcceptable'
1300 $ref: '#/components/responses/Conflict'
1302 $ref: '#/components/responses/UnprocessableEntity'
1304 $ref: '#/components/responses/InternalServerError'
1306 $ref: '#/components/responses/ServiceUnavailable'
1308 $ref: '#/components/responses/UnexpectedError'
1310 $ref: '#/components/responses/UnexpectedError'
1313 # BEGIN NS Instances
1314 '/nslcm/v1/ns_instances':
1318 summary: Query information about multiple NS instances
1319 description: Query information about multiple NS isntances
1320 operationId: getNSinstances
1327 $ref: '#/components/schemas/ArrayOfNsInstance'
1330 $ref: '#/components/schemas/ArrayOfNsInstance'
1332 $ref: '#/components/responses/BadRequest'
1334 $ref: '#/components/responses/Unauthorized'
1336 $ref: '#/components/responses/Forbidden'
1338 $ref: '#/components/responses/NotFound'
1340 $ref: '#/components/responses/MethodNotAllowed'
1342 $ref: '#/components/responses/NotAcceptable'
1344 $ref: '#/components/responses/Conflict'
1346 $ref: '#/components/responses/UnprocessableEntity'
1348 $ref: '#/components/responses/InternalServerError'
1350 $ref: '#/components/responses/ServiceUnavailable'
1352 $ref: '#/components/responses/UnexpectedError'
1354 $ref: '#/components/responses/UnexpectedError'
1358 summary: Create a new NS instance resource
1359 description: Create a new NS instance resource
1360 operationId: addNSinstance
1362 $ref: '#/components/requestBodies/InstantiateNsRequest'
1365 description: Created
1374 $ref: '#/components/schemas/ObjectId'
1377 $ref: '#/components/schemas/ObjectId'
1379 $ref: '#/components/responses/BadRequest'
1381 $ref: '#/components/responses/Unauthorized'
1383 $ref: '#/components/responses/Forbidden'
1385 $ref: '#/components/responses/NotFound'
1387 $ref: '#/components/responses/MethodNotAllowed'
1389 $ref: '#/components/responses/NotAcceptable'
1391 $ref: '#/components/responses/Conflict'
1393 $ref: '#/components/responses/UnprocessableEntity'
1395 $ref: '#/components/responses/InternalServerError'
1397 $ref: '#/components/responses/ServiceUnavailable'
1399 $ref: '#/components/responses/UnexpectedError'
1401 $ref: '#/components/responses/UnexpectedError'
1402 '/nslcm/v1/ns_instances/{nsInstanceId}':
1404 - name: nsInstanceId
1407 description: NS Instance ID
1410 - name: vcaStatusRefresh
1413 description: Set to true if vca status needs to be refreshed.
1419 summary: Read an individual NS instance resource
1420 description: Read an individual NS instance resource
1421 operationId: getNSinstance
1428 $ref: '#/components/schemas/NsInstance'
1431 $ref: '#/components/schemas/NsInstance'
1433 $ref: '#/components/responses/BadRequest'
1435 $ref: '#/components/responses/Unauthorized'
1437 $ref: '#/components/responses/Forbidden'
1439 $ref: '#/components/responses/NotFound'
1441 $ref: '#/components/responses/MethodNotAllowed'
1443 $ref: '#/components/responses/NotAcceptable'
1445 $ref: '#/components/responses/Conflict'
1447 $ref: '#/components/responses/UnprocessableEntity'
1449 $ref: '#/components/responses/InternalServerError'
1451 $ref: '#/components/responses/ServiceUnavailable'
1453 $ref: '#/components/responses/UnexpectedError'
1455 $ref: '#/components/responses/UnexpectedError'
1459 summary: Delete an individual NS instance resource
1460 description: Delete an individual NS instance resource
1461 operationId: deleteNSinstance
1464 description: No Content
1466 $ref: '#/components/responses/BadRequest'
1468 $ref: '#/components/responses/Unauthorized'
1470 $ref: '#/components/responses/Forbidden'
1472 $ref: '#/components/responses/NotFound'
1474 $ref: '#/components/responses/MethodNotAllowed'
1476 $ref: '#/components/responses/NotAcceptable'
1478 $ref: '#/components/responses/Conflict'
1480 $ref: '#/components/responses/UnprocessableEntity'
1482 $ref: '#/components/responses/InternalServerError'
1484 $ref: '#/components/responses/ServiceUnavailable'
1486 $ref: '#/components/responses/UnexpectedError'
1488 $ref: '#/components/responses/UnexpectedError'
1489 '/nslcm/v1/ns_instances/{nsInstanceId}/instantiate':
1491 - name: nsInstanceId
1494 description: NS Instance ID
1500 summary: Instantiate a NS
1502 Instantiate a NS. The precondition is that the NS instance must have
1503 been created and must be in NOT_INSTANTIATED state. As a result of the
1504 success of this operation, the NFVO creates a "NS Lifecycle Operation
1505 Occurrence" resource for the request, and the NS instance state becomes
1507 operationId: instantiateNSinstance
1509 $ref: '#/components/requestBodies/InstantiateNsRequest'
1512 description: Accepted
1516 It must point to the new "NS Lifecycle Operation Occurrence"
1517 resource, i.e. an URI like ".../ns_lcm_op_occs/{nsLcmOpOccId}"
1524 $ref: '#/components/schemas/ObjectId'
1527 $ref: '#/components/schemas/ObjectId'
1529 $ref: '#/components/responses/BadRequest'
1531 $ref: '#/components/responses/Unauthorized'
1533 $ref: '#/components/responses/Forbidden'
1535 $ref: '#/components/responses/NotFound'
1537 $ref: '#/components/responses/MethodNotAllowed'
1539 $ref: '#/components/responses/NotAcceptable'
1541 $ref: '#/components/responses/Conflict'
1543 $ref: '#/components/responses/UnprocessableEntity'
1545 $ref: '#/components/responses/InternalServerError'
1547 $ref: '#/components/responses/ServiceUnavailable'
1549 $ref: '#/components/responses/UnexpectedError'
1551 $ref: '#/components/responses/UnexpectedError'
1552 '/nslcm/v1/ns_instances/{nsInstanceId}/scale':
1554 - name: nsInstanceId
1557 description: NS Instance ID
1563 summary: Scale a NS instance
1565 Scale a NS instance. The precondition is that the NS instance must have
1566 been created and must be in INSTANTIATED state. As a result of the
1567 success of this operation, the NFVO creates a "NS Lifecycle Operation
1568 Occurrence" resource for the request, and the NS instance state remains
1570 operationId: scaleNSinstance
1572 $ref: '#/components/requestBodies/ScaleNsRequest'
1575 description: Accepted
1579 It must point to the new "NS Lifecycle Operation Occurrence"
1580 resource, i.e. an URI like ".../ns_lcm_op_occs/{nsLcmOpOccId}"
1585 $ref: '#/components/responses/BadRequest'
1587 $ref: '#/components/responses/Unauthorized'
1589 $ref: '#/components/responses/Forbidden'
1591 $ref: '#/components/responses/NotFound'
1593 $ref: '#/components/responses/MethodNotAllowed'
1595 $ref: '#/components/responses/NotAcceptable'
1597 $ref: '#/components/responses/Conflict'
1599 $ref: '#/components/responses/UnprocessableEntity'
1601 $ref: '#/components/responses/InternalServerError'
1603 $ref: '#/components/responses/ServiceUnavailable'
1605 $ref: '#/components/responses/UnexpectedError'
1607 $ref: '#/components/responses/UnexpectedError'
1608 '/nslcm/v1/ns_instances/{nsInstanceId}/terminate':
1610 - name: nsInstanceId
1613 description: NS Instance ID
1619 summary: Terminate a NS instance
1621 Terminate a NS instance. The precondition is that the NS instance must have
1622 been created and must be in INSTANTIATED state. As a result of the
1623 success of this operation, the NFVO creates a "NS Lifecycle Operation
1624 Occurrence" resource for the request, and the NS instance state becomes
1626 operationId: terminateNSinstance
1628 # Request data is not required
1629 $ref: '#/components/requestBodies/TerminateNsRequest'
1632 description: Accepted
1636 It must point to the new "NS Lifecycle Operation Occurrence"
1637 resource, i.e. an URI like ".../ns_lcm_op_occs/{nsLcmOpOccId}"
1644 $ref: '#/components/schemas/ObjectId'
1647 $ref: '#/components/schemas/ObjectId'
1649 $ref: '#/components/responses/BadRequest'
1651 $ref: '#/components/responses/Unauthorized'
1653 $ref: '#/components/responses/Forbidden'
1655 $ref: '#/components/responses/NotFound'
1657 $ref: '#/components/responses/MethodNotAllowed'
1659 $ref: '#/components/responses/NotAcceptable'
1661 $ref: '#/components/responses/Conflict'
1663 $ref: '#/components/responses/UnprocessableEntity'
1665 $ref: '#/components/responses/InternalServerError'
1667 $ref: '#/components/responses/ServiceUnavailable'
1669 $ref: '#/components/responses/UnexpectedError'
1671 $ref: '#/components/responses/UnexpectedError'
1672 '/nslcm/v1/ns_instances/{nsInstanceId}/action':
1674 - name: nsInstanceId
1677 description: NS Instance ID
1683 summary: Execute an action on a NS instance
1685 Execute an action on a NS instance.
1686 The NS instance must have been created and must be in INSTANTIATED state.
1687 operationId: actionOnNSinstance
1692 $ref: '#/components/schemas/NSinstanceActionRequest'
1695 $ref: '#/components/schemas/NSinstanceActionRequest'
1698 description: Accepted
1702 It must point to the new "NS Lifecycle Operation Occurrence"
1703 resource, i.e. an URI like ".../ns_lcm_op_occs/{nsLcmOpOccId}"
1710 $ref: '#/components/schemas/ObjectId'
1713 $ref: '#/components/schemas/ObjectId'
1715 $ref: '#/components/responses/BadRequest'
1717 $ref: '#/components/responses/Unauthorized'
1719 $ref: '#/components/responses/Forbidden'
1721 $ref: '#/components/responses/NotFound'
1723 $ref: '#/components/responses/MethodNotAllowed'
1725 $ref: '#/components/responses/NotAcceptable'
1727 $ref: '#/components/responses/Conflict'
1729 $ref: '#/components/responses/UnprocessableEntity'
1731 $ref: '#/components/responses/InternalServerError'
1733 $ref: '#/components/responses/ServiceUnavailable'
1735 $ref: '#/components/responses/UnexpectedError'
1737 $ref: '#/components/responses/UnexpectedError'
1738 '/nslcm/v1/ns_instances_content':
1742 summary: Query information about multiple NS instances
1743 description: Query information about multiple NS isntances
1744 operationId: getNSinstancesContent
1751 $ref: '#/components/schemas/ArrayOfNsInstance'
1754 $ref: '#/components/schemas/ArrayOfNsInstance'
1756 $ref: '#/components/responses/BadRequest'
1758 $ref: '#/components/responses/Unauthorized'
1760 $ref: '#/components/responses/Forbidden'
1762 $ref: '#/components/responses/NotFound'
1764 $ref: '#/components/responses/MethodNotAllowed'
1766 $ref: '#/components/responses/NotAcceptable'
1768 $ref: '#/components/responses/Conflict'
1770 $ref: '#/components/responses/UnprocessableEntity'
1772 $ref: '#/components/responses/InternalServerError'
1774 $ref: '#/components/responses/ServiceUnavailable'
1776 $ref: '#/components/responses/UnexpectedError'
1778 $ref: '#/components/responses/UnexpectedError'
1782 summary: Create a new NS instance
1783 description: Create a new NS instance
1784 operationId: createNSinstanceContent
1786 $ref: '#/components/requestBodies/InstantiateNsRequest'
1789 description: Created
1798 $ref: '#/components/schemas/CreateNSinstanceContentResponse'
1801 $ref: '#/components/schemas/CreateNSinstanceContentResponse'
1803 $ref: '#/components/responses/BadRequest'
1805 $ref: '#/components/responses/Unauthorized'
1807 $ref: '#/components/responses/Forbidden'
1809 $ref: '#/components/responses/NotFound'
1811 $ref: '#/components/responses/MethodNotAllowed'
1813 $ref: '#/components/responses/NotAcceptable'
1815 $ref: '#/components/responses/Conflict'
1817 $ref: '#/components/responses/UnprocessableEntity'
1819 $ref: '#/components/responses/InternalServerError'
1821 $ref: '#/components/responses/ServiceUnavailable'
1823 $ref: '#/components/responses/UnexpectedError'
1825 $ref: '#/components/responses/UnexpectedError'
1826 '/nslcm/v1/ns_instances_content/{nsInstanceContentId}':
1828 - name: nsInstanceContentId
1831 description: NS Instance Content ID
1837 summary: Read an individual NS instance resource
1838 description: Read an individual NS instance resource
1839 operationId: getNSinstanceContent
1846 $ref: '#/components/schemas/NsInstance'
1849 $ref: '#/components/schemas/NsInstance'
1851 $ref: '#/components/responses/BadRequest'
1853 $ref: '#/components/responses/Unauthorized'
1855 $ref: '#/components/responses/Forbidden'
1857 $ref: '#/components/responses/NotFound'
1859 $ref: '#/components/responses/MethodNotAllowed'
1861 $ref: '#/components/responses/NotAcceptable'
1863 $ref: '#/components/responses/Conflict'
1865 $ref: '#/components/responses/UnprocessableEntity'
1867 $ref: '#/components/responses/InternalServerError'
1869 $ref: '#/components/responses/ServiceUnavailable'
1871 $ref: '#/components/responses/UnexpectedError'
1873 $ref: '#/components/responses/UnexpectedError'
1877 summary: Delete an individual NS instance resource
1878 description: Delete an individual NS instance resource
1879 operationId: deleteNSinstanceContent
1882 description: Accepted
1886 $ref: '#/components/schemas/ObjectId'
1889 $ref: '#/components/schemas/ObjectId'
1891 description: No Content
1893 $ref: '#/components/responses/BadRequest'
1895 $ref: '#/components/responses/Unauthorized'
1897 $ref: '#/components/responses/Forbidden'
1899 $ref: '#/components/responses/NotFound'
1901 $ref: '#/components/responses/MethodNotAllowed'
1903 $ref: '#/components/responses/NotAcceptable'
1905 $ref: '#/components/responses/Conflict'
1907 $ref: '#/components/responses/UnprocessableEntity'
1909 $ref: '#/components/responses/InternalServerError'
1911 $ref: '#/components/responses/ServiceUnavailable'
1913 $ref: '#/components/responses/UnexpectedError'
1915 $ref: '#/components/responses/UnexpectedError'
1916 '/nslcm/v1/ns_lcm_op_occs':
1920 summary: Query information about multiple NS LCM Operation Occurrences
1921 description: Query information about multiple NS LCM Operation Occurrences
1922 operationId: getNSLCMOpOccs
1929 $ref: '#/components/schemas/ArrayOfNsLcmOpOcc'
1932 $ref: '#/components/schemas/ArrayOfNsLcmOpOcc'
1934 $ref: '#/components/responses/BadRequest'
1936 $ref: '#/components/responses/Unauthorized'
1938 $ref: '#/components/responses/Forbidden'
1940 $ref: '#/components/responses/NotFound'
1942 $ref: '#/components/responses/MethodNotAllowed'
1944 $ref: '#/components/responses/NotAcceptable'
1946 $ref: '#/components/responses/Conflict'
1948 $ref: '#/components/responses/UnprocessableEntity'
1950 $ref: '#/components/responses/InternalServerError'
1952 $ref: '#/components/responses/ServiceUnavailable'
1954 $ref: '#/components/responses/UnexpectedError'
1956 $ref: '#/components/responses/UnexpectedError'
1957 '/nslcm/v1/ns_lcm_op_occs/{nsLcmOpOccId}':
1959 - name: nsLcmOpOccId
1962 description: NS LCM Operation Occurrence ID
1968 summary: Query information about an individual NS LCM Operation Occurrence
1969 description: Query information about an individual NS LCM Operation Occurrence
1970 operationId: getNSLCMOpOcc
1977 $ref: '#/components/schemas/NsLcmOpOcc'
1980 $ref: '#/components/schemas/NsLcmOpOcc'
1982 $ref: '#/components/responses/BadRequest'
1984 $ref: '#/components/responses/Unauthorized'
1986 $ref: '#/components/responses/Forbidden'
1988 $ref: '#/components/responses/NotFound'
1990 $ref: '#/components/responses/MethodNotAllowed'
1992 $ref: '#/components/responses/NotAcceptable'
1994 $ref: '#/components/responses/Conflict'
1996 $ref: '#/components/responses/UnprocessableEntity'
1998 $ref: '#/components/responses/InternalServerError'
2000 $ref: '#/components/responses/ServiceUnavailable'
2002 $ref: '#/components/responses/UnexpectedError'
2004 $ref: '#/components/responses/UnexpectedError'
2005 '/nslcm/v1/vnf_instances':
2009 summary: Query information about multiple VNF Instances
2010 description: Query information about multiple VNF Instances
2011 operationId: getVnfInstances
2018 $ref: '#/components/schemas/ArrayOfVnfInstanceInfo'
2021 $ref: '#/components/schemas/ArrayOfVnfInstanceInfo'
2023 $ref: '#/components/responses/BadRequest'
2025 $ref: '#/components/responses/Unauthorized'
2027 $ref: '#/components/responses/Forbidden'
2029 $ref: '#/components/responses/NotFound'
2031 $ref: '#/components/responses/MethodNotAllowed'
2033 $ref: '#/components/responses/NotAcceptable'
2035 $ref: '#/components/responses/Conflict'
2037 $ref: '#/components/responses/UnprocessableEntity'
2039 $ref: '#/components/responses/InternalServerError'
2041 $ref: '#/components/responses/ServiceUnavailable'
2043 $ref: '#/components/responses/UnexpectedError'
2045 $ref: '#/components/responses/UnexpectedError'
2046 '/nslcm/v1/vnf_instances/{vnfInstanceId}':
2048 - name: vnfInstanceId
2051 description: VNF Instance ID
2057 summary: Query information about an individual VNF Instance
2058 description: Query information about an individual VNF Instance
2059 operationId: getVnfInstance
2066 $ref: '#/components/schemas/VnfInstanceInfo'
2069 $ref: '#/components/schemas/VnfInstanceInfo'
2071 $ref: '#/components/responses/BadRequest'
2073 $ref: '#/components/responses/Unauthorized'
2075 $ref: '#/components/responses/Forbidden'
2077 $ref: '#/components/responses/NotFound'
2079 $ref: '#/components/responses/MethodNotAllowed'
2081 $ref: '#/components/responses/NotAcceptable'
2083 $ref: '#/components/responses/Conflict'
2085 $ref: '#/components/responses/UnprocessableEntity'
2087 $ref: '#/components/responses/InternalServerError'
2089 $ref: '#/components/responses/ServiceUnavailable'
2091 $ref: '#/components/responses/UnexpectedError'
2093 $ref: '#/components/responses/UnexpectedError'
2094 /nslcm/v1/subscriptions:
2098 summary: Query information about multiple NS instance subscription
2099 description: Query information about multiple NS instance subscription
2100 operationId: getNsSubcriptions
2107 $ref: '#/components/schemas/ArrayOfNslcmSubscriptionInfo'
2110 $ref: '#/components/schemas/ArrayOfNslcmSubscriptionInfo'
2112 $ref: '#/components/responses/BadRequest'
2114 $ref: '#/components/responses/Unauthorized'
2116 $ref: '#/components/responses/Forbidden'
2118 $ref: '#/components/responses/NotFound'
2120 $ref: '#/components/responses/MethodNotAllowed'
2122 $ref: '#/components/responses/NotAcceptable'
2124 $ref: '#/components/responses/Conflict'
2126 $ref: '#/components/responses/UnprocessableEntity'
2128 $ref: '#/components/responses/InternalServerError'
2130 $ref: '#/components/responses/ServiceUnavailable'
2132 $ref: '#/components/responses/UnexpectedError'
2134 $ref: '#/components/responses/UnexpectedError'
2138 summary: Create a new subscription for the Network service
2139 description: Create a new subscription for the Network service
2140 operationId: addNsSubcriptions
2142 $ref: '#/components/requestBodies/NslcmSubscriptionRequest'
2145 description: Created
2153 $ref: '#/components/schemas/NslcmSubscriptionResponse'
2156 $ref: '#/components/schemas/NslcmSubscriptionResponse'
2158 $ref: '#/components/responses/BadRequest'
2160 $ref: '#/components/responses/Unauthorized'
2162 $ref: '#/components/responses/Forbidden'
2164 $ref: '#/components/responses/NotFound'
2166 $ref: '#/components/responses/MethodNotAllowed'
2168 $ref: '#/components/responses/NotAcceptable'
2170 $ref: '#/components/responses/Conflict'
2172 $ref: '#/components/responses/UnprocessableEntity'
2174 $ref: '#/components/responses/InternalServerError'
2176 $ref: '#/components/responses/ServiceUnavailable'
2178 $ref: '#/components/responses/UnexpectedError'
2180 $ref: '#/components/responses/UnexpectedError'
2181 '/nslcm/v1/subscriptions/{nsSubscriptionsId}':
2183 - name: nsSubscriptionsId
2186 description: Network Service Subscription ID
2192 summary: Read information about an individual Network Service Subscription
2193 description: Read information about an individual Network Service Subscription
2194 operationId: getNsSubcriptionId
2201 $ref: '#/components/schemas/NslcmSubscriptionInfo'
2204 $ref: '#/components/schemas/NslcmSubscriptionInfo'
2206 $ref: '#/components/responses/BadRequest'
2208 $ref: '#/components/responses/Unauthorized'
2210 $ref: '#/components/responses/Forbidden'
2212 $ref: '#/components/responses/NotFound'
2214 $ref: '#/components/responses/MethodNotAllowed'
2216 $ref: '#/components/responses/NotAcceptable'
2218 $ref: '#/components/responses/Conflict'
2220 $ref: '#/components/responses/UnprocessableEntity'
2222 $ref: '#/components/responses/InternalServerError'
2224 $ref: '#/components/responses/ServiceUnavailable'
2226 $ref: '#/components/responses/UnexpectedError'
2228 $ref: '#/components/responses/UnexpectedError'
2232 summary: Delete an individual Network Service Subscription
2233 description: Delete an individual Network Service Subscription
2234 operationId: deleteNsSubcriptionId
2237 description: No Content
2239 $ref: '#/components/responses/BadRequest'
2241 $ref: '#/components/responses/Unauthorized'
2243 $ref: '#/components/responses/Forbidden'
2245 $ref: '#/components/responses/NotFound'
2247 $ref: '#/components/responses/MethodNotAllowed'
2249 $ref: '#/components/responses/NotAcceptable'
2251 $ref: '#/components/responses/Conflict'
2253 $ref: '#/components/responses/UnprocessableEntity'
2255 $ref: '#/components/responses/InternalServerError'
2257 $ref: '#/components/responses/ServiceUnavailable'
2259 $ref: '#/components/responses/UnexpectedError'
2261 $ref: '#/components/responses/UnexpectedError'
2269 summary: Query information about multiple alarms
2270 description: Query information about multiple alarms
2271 operationId: getAlarms
2278 $ref: '#/components/schemas/ArrayOfAlarm'
2281 $ref: '#/components/schemas/ArrayOfAlarm'
2283 $ref: '#/components/responses/BadRequest'
2285 $ref: '#/components/responses/Unauthorized'
2287 $ref: '#/components/responses/Forbidden'
2289 $ref: '#/components/responses/NotFound'
2291 $ref: '#/components/responses/MethodNotAllowed'
2293 $ref: '#/components/responses/NotAcceptable'
2295 $ref: '#/components/responses/Conflict'
2297 $ref: '#/components/responses/UnprocessableEntity'
2299 $ref: '#/components/responses/InternalServerError'
2301 $ref: '#/components/responses/ServiceUnavailable'
2303 $ref: '#/components/responses/UnexpectedError'
2305 $ref: '#/components/responses/UnexpectedError'
2306 '/nsfm/v1/alarms/{uuid}':
2311 description: Alarm UUID
2317 summary: Read an individual Alarm
2318 description: Read an individual Alarm
2319 operationId: getAlarm
2326 $ref: '#/components/schemas/Alarm'
2329 $ref: '#/components/schemas/Alarm'
2331 $ref: '#/components/responses/BadRequest'
2333 $ref: '#/components/responses/Unauthorized'
2335 $ref: '#/components/responses/Forbidden'
2337 $ref: '#/components/responses/NotFound'
2339 $ref: '#/components/responses/MethodNotAllowed'
2341 $ref: '#/components/responses/NotAcceptable'
2343 $ref: '#/components/responses/Conflict'
2345 $ref: '#/components/responses/UnprocessableEntity'
2347 $ref: '#/components/responses/InternalServerError'
2349 $ref: '#/components/responses/ServiceUnavailable'
2351 $ref: '#/components/responses/UnexpectedError'
2353 $ref: '#/components/responses/UnexpectedError'
2357 summary: Modify the data of an individual Alarm
2358 description: Modify the data of an individual Alarm
2359 operationId: updateAlarm
2361 $ref: '#/components/requestBodies/AlarmInfoModifications'
2364 description: No Content
2366 $ref: '#/components/responses/BadRequest'
2368 $ref: '#/components/responses/Unauthorized'
2370 $ref: '#/components/responses/Forbidden'
2372 $ref: '#/components/responses/NotFound'
2374 $ref: '#/components/responses/MethodNotAllowed'
2376 $ref: '#/components/responses/NotAcceptable'
2378 $ref: '#/components/responses/Conflict'
2380 $ref: '#/components/responses/UnprocessableEntity'
2382 $ref: '#/components/responses/InternalServerError'
2384 $ref: '#/components/responses/ServiceUnavailable'
2386 $ref: '#/components/responses/UnexpectedError'
2388 $ref: '#/components/responses/UnexpectedError'
2391 # BEGIN NetSlice Templates
2392 '/nst/v1/netslice_templates':
2395 - "NetSlice templates"
2396 summary: Query information about multiple NetSlice template resources
2397 description: Query information about multiple NetSlice template resources
2398 operationId: getNSTs
2405 $ref: '#/components/schemas/ArrayOfNstInfo'
2408 $ref: '#/components/schemas/ArrayOfNstInfo'
2410 $ref: '#/components/responses/BadRequest'
2412 $ref: '#/components/responses/Unauthorized'
2414 $ref: '#/components/responses/Forbidden'
2416 $ref: '#/components/responses/NotFound'
2418 $ref: '#/components/responses/MethodNotAllowed'
2420 $ref: '#/components/responses/NotAcceptable'
2422 $ref: '#/components/responses/Conflict'
2424 $ref: '#/components/responses/UnprocessableEntity'
2426 $ref: '#/components/responses/InternalServerError'
2428 $ref: '#/components/responses/ServiceUnavailable'
2430 $ref: '#/components/responses/UnexpectedError'
2432 $ref: '#/components/responses/UnexpectedError'
2435 - "NetSlice templates"
2436 summary: Create a new NetSlice template resource
2437 description: Create a new NetSlice template resource
2440 $ref: '#/components/requestBodies/CreateNstInfoRequest'
2443 description: Created
2452 $ref: '#/components/schemas/ObjectId'
2455 $ref: '#/components/schemas/ObjectId'
2457 $ref: '#/components/responses/BadRequest'
2459 $ref: '#/components/responses/Unauthorized'
2461 $ref: '#/components/responses/Forbidden'
2463 $ref: '#/components/responses/NotFound'
2465 $ref: '#/components/responses/MethodNotAllowed'
2467 $ref: '#/components/responses/NotAcceptable'
2469 $ref: '#/components/responses/Conflict'
2471 $ref: '#/components/responses/UnprocessableEntity'
2473 $ref: '#/components/responses/InternalServerError'
2475 $ref: '#/components/responses/ServiceUnavailable'
2477 $ref: '#/components/responses/UnexpectedError'
2479 $ref: '#/components/responses/UnexpectedError'
2480 '/nst/v1/netslice_templates/{netsliceTemplateId}':
2482 - name: netsliceTemplateId
2485 description: NetSlice Template ID
2490 - "NetSlice templates"
2491 summary: Read information about an individual NetSlice template resource
2492 description: Read information about an individual NetSlice template resource
2500 $ref: '#/components/schemas/NstInfo'
2503 $ref: '#/components/schemas/NstInfo'
2505 $ref: '#/components/responses/BadRequest'
2507 $ref: '#/components/responses/Unauthorized'
2509 $ref: '#/components/responses/Forbidden'
2511 $ref: '#/components/responses/NotFound'
2513 $ref: '#/components/responses/MethodNotAllowed'
2515 $ref: '#/components/responses/NotAcceptable'
2517 $ref: '#/components/responses/Conflict'
2519 $ref: '#/components/responses/UnprocessableEntity'
2521 $ref: '#/components/responses/InternalServerError'
2523 $ref: '#/components/responses/ServiceUnavailable'
2525 $ref: '#/components/responses/UnexpectedError'
2527 $ref: '#/components/responses/UnexpectedError'
2530 - "NetSlice templates"
2531 summary: Delete an individual NetSlice template resource
2532 description: Delete an individual NetSlice template resource
2533 operationId: deleteNST
2536 description: No Content
2538 $ref: '#/components/responses/BadRequest'
2540 $ref: '#/components/responses/Unauthorized'
2542 $ref: '#/components/responses/Forbidden'
2544 $ref: '#/components/responses/NotFound'
2546 $ref: '#/components/responses/MethodNotAllowed'
2548 $ref: '#/components/responses/NotAcceptable'
2550 $ref: '#/components/responses/Conflict'
2552 $ref: '#/components/responses/UnprocessableEntity'
2554 $ref: '#/components/responses/InternalServerError'
2556 $ref: '#/components/responses/ServiceUnavailable'
2558 $ref: '#/components/responses/UnexpectedError'
2560 $ref: '#/components/responses/UnexpectedError'
2561 '/nst/v1/netslice_templates/{netsliceTemplateId}/artifacts/{artifactPath}':
2563 - name: netsliceTemplateId
2566 description: NetSlice Template ID
2569 - name: artifactPath
2572 description: Artifact Path
2577 - "NetSlice templates"
2578 summary: Fetch individual NetSlice Template artifact
2579 description: Fetch individual NetSlice Template artifact
2580 operationId: getNstArtifact
2585 application/octet-stream:
2590 description: Partial Content
2596 application/octet-stream:
2601 $ref: '#/components/responses/BadRequest'
2603 $ref: '#/components/responses/Unauthorized'
2605 $ref: '#/components/responses/Forbidden'
2607 $ref: '#/components/responses/NotFound'
2609 $ref: '#/components/responses/MethodNotAllowed'
2611 $ref: '#/components/responses/NotAcceptable'
2613 $ref: '#/components/responses/Conflict'
2615 $ref: '#/components/responses/UnprocessableEntity'
2617 $ref: '#/components/responses/InternalServerError'
2619 $ref: '#/components/responses/ServiceUnavailable'
2621 $ref: '#/components/responses/UnexpectedError'
2623 $ref: '#/components/responses/UnexpectedError'
2624 '/nst/v1/netslice_templates/{netsliceTemplateId}/nst':
2626 - name: netsliceTemplateId
2629 description: NetSlice Template ID
2634 - "NetSlice templates"
2635 summary: Read NST of an on-boarded NetSlice Template
2636 description: Read NST of an on-boarded NetSlice Template
2637 operationId: getNstNst
2644 $ref: '#/components/schemas/NetSliceTemplate'
2646 $ref: '#/components/responses/BadRequest'
2648 $ref: '#/components/responses/Unauthorized'
2650 $ref: '#/components/responses/Forbidden'
2652 $ref: '#/components/responses/NotFound'
2654 $ref: '#/components/responses/MethodNotAllowed'
2656 $ref: '#/components/responses/NotAcceptable'
2658 $ref: '#/components/responses/Conflict'
2660 $ref: '#/components/responses/UnprocessableEntity'
2662 $ref: '#/components/responses/InternalServerError'
2664 $ref: '#/components/responses/ServiceUnavailable'
2666 $ref: '#/components/responses/UnexpectedError'
2668 $ref: '#/components/responses/UnexpectedError'
2669 '/nst/v1/netslice_templates/{netsliceTemplateId}/nst_content':
2671 - name: netsliceTemplateId
2674 description: NetSlice Template ID
2679 - "NetSlice templates"
2680 summary: Fetch the content of a NST
2681 description: Fetch the content of a NST
2682 operationId: getNSTcontent
2689 $ref: '#/components/schemas/NetSlicePackage'
2691 description: Partial Content
2699 $ref: '#/components/schemas/NetSlicePackage'
2701 $ref: '#/components/responses/BadRequest'
2703 $ref: '#/components/responses/Unauthorized'
2705 $ref: '#/components/responses/Forbidden'
2707 $ref: '#/components/responses/NotFound'
2709 $ref: '#/components/responses/MethodNotAllowed'
2711 $ref: '#/components/responses/NotAcceptable'
2713 $ref: '#/components/responses/Conflict'
2715 $ref: '#/components/responses/UnprocessableEntity'
2717 $ref: '#/components/responses/InternalServerError'
2719 $ref: '#/components/responses/ServiceUnavailable'
2721 $ref: '#/components/responses/UnexpectedError'
2723 $ref: '#/components/responses/UnexpectedError'
2726 - "NetSlice templates"
2727 summary: Upload the content of a NST
2728 description: Upload the content of a NST
2729 operationId: updateNSTcontent
2731 $ref: '#/components/requestBodies/NetSlicePackage'
2734 description: Accepted
2736 description: No Content
2738 $ref: '#/components/responses/BadRequest'
2740 $ref: '#/components/responses/Unauthorized'
2742 $ref: '#/components/responses/Forbidden'
2744 $ref: '#/components/responses/NotFound'
2746 $ref: '#/components/responses/MethodNotAllowed'
2748 $ref: '#/components/responses/NotAcceptable'
2750 $ref: '#/components/responses/Conflict'
2752 $ref: '#/components/responses/UnprocessableEntity'
2754 $ref: '#/components/responses/InternalServerError'
2756 $ref: '#/components/responses/ServiceUnavailable'
2758 $ref: '#/components/responses/UnexpectedError'
2760 $ref: '#/components/responses/UnexpectedError'
2761 '/nst/v1/netslice_templates_content':
2764 - "NetSlice templates"
2765 summary: Upload a NetSlice package by providing the content of the NetSlice package
2766 description: Upload a NetSlice package by providing the content of the NetSlice package
2767 operationId: uploadNstContent
2772 $ref: '#/components/schemas/NetSlicePackage'
2775 description: Created
2784 $ref: '#/components/schemas/ObjectId'
2787 $ref: '#/components/schemas/ObjectId'
2789 description: Accepted
2791 description: No Content
2793 $ref: '#/components/responses/BadRequest'
2795 $ref: '#/components/responses/Unauthorized'
2797 $ref: '#/components/responses/Forbidden'
2799 $ref: '#/components/responses/NotFound'
2801 $ref: '#/components/responses/MethodNotAllowed'
2803 $ref: '#/components/responses/NotAcceptable'
2805 $ref: '#/components/responses/Conflict'
2807 $ref: '#/components/responses/UnprocessableEntity'
2809 $ref: '#/components/responses/InternalServerError'
2811 $ref: '#/components/responses/ServiceUnavailable'
2813 $ref: '#/components/responses/UnexpectedError'
2815 $ref: '#/components/responses/UnexpectedError'
2818 - "NetSlice templates"
2819 summary: Query information about multiple NetSlice Template resources
2820 description: Query information about multiple NetSlice Template resources
2821 operationId: getNstContent
2828 $ref: '#/components/schemas/ArrayOfNstInfo'
2831 $ref: '#/components/schemas/ArrayOfNstInfo'
2833 description: Partial Content
2839 application/octet-stream:
2844 $ref: '#/components/responses/BadRequest'
2846 $ref: '#/components/responses/Unauthorized'
2848 $ref: '#/components/responses/Forbidden'
2850 $ref: '#/components/responses/NotFound'
2852 $ref: '#/components/responses/MethodNotAllowed'
2854 $ref: '#/components/responses/NotAcceptable'
2856 $ref: '#/components/responses/Conflict'
2858 $ref: '#/components/responses/UnprocessableEntity'
2860 $ref: '#/components/responses/InternalServerError'
2862 $ref: '#/components/responses/ServiceUnavailable'
2864 $ref: '#/components/responses/UnexpectedError'
2866 $ref: '#/components/responses/UnexpectedError'
2867 '/nst/v1/netslice_templates_content/{netsliceTemplateContentId}':
2869 - name: netsliceTemplateContentId
2872 description: NetSlice Template ID
2877 - "NetSlice templates"
2878 summary: Read information about an individual NetSlice Template resource
2879 description: Read information about an individual NetSlice Template resource
2880 operationId: getNstIdContent
2887 $ref: '#/components/schemas/NstInfo'
2890 $ref: '#/components/schemas/NstInfo'
2892 $ref: '#/components/responses/BadRequest'
2894 $ref: '#/components/responses/Unauthorized'
2896 $ref: '#/components/responses/Forbidden'
2898 $ref: '#/components/responses/NotFound'
2900 $ref: '#/components/responses/MethodNotAllowed'
2902 $ref: '#/components/responses/NotAcceptable'
2904 $ref: '#/components/responses/Conflict'
2906 $ref: '#/components/responses/UnprocessableEntity'
2908 $ref: '#/components/responses/InternalServerError'
2910 $ref: '#/components/responses/ServiceUnavailable'
2912 $ref: '#/components/responses/UnexpectedError'
2914 $ref: '#/components/responses/UnexpectedError'
2917 - "NetSlice templates"
2918 summary: Modify an individual NetSlice Template resource
2919 description: Modify an individual NetSlice Template resource
2920 operationId: updateNstIdContent
2922 $ref: '#/components/requestBodies/NstInfoModifications'
2925 description: No Content
2927 $ref: '#/components/responses/BadRequest'
2929 $ref: '#/components/responses/Unauthorized'
2931 $ref: '#/components/responses/Forbidden'
2933 $ref: '#/components/responses/NotFound'
2935 $ref: '#/components/responses/MethodNotAllowed'
2937 $ref: '#/components/responses/NotAcceptable'
2939 $ref: '#/components/responses/Conflict'
2941 $ref: '#/components/responses/UnprocessableEntity'
2943 $ref: '#/components/responses/InternalServerError'
2945 $ref: '#/components/responses/ServiceUnavailable'
2947 $ref: '#/components/responses/UnexpectedError'
2949 $ref: '#/components/responses/UnexpectedError'
2952 - "NetSlice templates"
2953 summary: Delete an individual NetSlice Template resource
2954 description: Delete an individual NetSlice Template resource
2955 operationId: deleteNstIdContent
2958 description: No Content
2960 $ref: '#/components/responses/BadRequest'
2962 $ref: '#/components/responses/Unauthorized'
2964 $ref: '#/components/responses/Forbidden'
2966 $ref: '#/components/responses/NotFound'
2968 $ref: '#/components/responses/MethodNotAllowed'
2970 $ref: '#/components/responses/NotAcceptable'
2972 $ref: '#/components/responses/Conflict'
2974 $ref: '#/components/responses/UnprocessableEntity'
2976 $ref: '#/components/responses/InternalServerError'
2978 $ref: '#/components/responses/ServiceUnavailable'
2980 $ref: '#/components/responses/UnexpectedError'
2982 $ref: '#/components/responses/UnexpectedError'
2983 # END NetSlice Templates
2985 # BEGIN NetSlice Instances
2986 '/nsilcm/v1/netslice_instances':
2989 - "NetSlice instances"
2990 summary: Query information about multiple NetSlice instances
2991 description: Query information about multiple NetSlice isntances
2992 operationId: getNSIs
2999 $ref: '#/components/schemas/ArrayOfNetSliceInstance'
3002 $ref: '#/components/schemas/ArrayOfNetSliceInstance'
3004 $ref: '#/components/responses/BadRequest'
3006 $ref: '#/components/responses/Unauthorized'
3008 $ref: '#/components/responses/Forbidden'
3010 $ref: '#/components/responses/NotFound'
3012 $ref: '#/components/responses/MethodNotAllowed'
3014 $ref: '#/components/responses/NotAcceptable'
3016 $ref: '#/components/responses/Conflict'
3018 $ref: '#/components/responses/UnprocessableEntity'
3020 $ref: '#/components/responses/InternalServerError'
3022 $ref: '#/components/responses/ServiceUnavailable'
3024 $ref: '#/components/responses/UnexpectedError'
3026 $ref: '#/components/responses/UnexpectedError'
3029 - "NetSlice instances"
3030 summary: Create a new NetSlice instance resource
3031 description: Create a new NetSlice instance resource
3034 $ref: '#/components/requestBodies/InstantiateNsiRequest'
3037 description: Created
3046 $ref: '#/components/schemas/ObjectId'
3049 $ref: '#/components/schemas/ObjectId'
3051 $ref: '#/components/responses/BadRequest'
3053 $ref: '#/components/responses/Unauthorized'
3055 $ref: '#/components/responses/Forbidden'
3057 $ref: '#/components/responses/NotFound'
3059 $ref: '#/components/responses/MethodNotAllowed'
3061 $ref: '#/components/responses/NotAcceptable'
3063 $ref: '#/components/responses/Conflict'
3065 $ref: '#/components/responses/UnprocessableEntity'
3067 $ref: '#/components/responses/InternalServerError'
3069 $ref: '#/components/responses/ServiceUnavailable'
3071 $ref: '#/components/responses/UnexpectedError'
3073 $ref: '#/components/responses/UnexpectedError'
3074 '/nsilcm/v1/netslice_instances/{netsliceInstanceId}':
3076 - name: netsliceInstanceId
3079 description: NetSlice Instance ID
3084 - "NetSlice instances"
3085 summary: Read an individual NetSlice instance resource
3086 description: Read an individual NetSlice instance resource
3094 $ref: '#/components/schemas/NetSliceInstance'
3097 $ref: '#/components/schemas/NetSliceInstance'
3099 $ref: '#/components/responses/BadRequest'
3101 $ref: '#/components/responses/Unauthorized'
3103 $ref: '#/components/responses/Forbidden'
3105 $ref: '#/components/responses/NotFound'
3107 $ref: '#/components/responses/MethodNotAllowed'
3109 $ref: '#/components/responses/NotAcceptable'
3111 $ref: '#/components/responses/Conflict'
3113 $ref: '#/components/responses/UnprocessableEntity'
3115 $ref: '#/components/responses/InternalServerError'
3117 $ref: '#/components/responses/ServiceUnavailable'
3119 $ref: '#/components/responses/UnexpectedError'
3121 $ref: '#/components/responses/UnexpectedError'
3124 - "NetSlice instances"
3125 summary: Delete an individual NetSlice instance resource
3126 description: Delete an individual NetSlice instance resource
3127 operationId: deleteNSI
3130 description: No Content
3132 $ref: '#/components/responses/BadRequest'
3134 $ref: '#/components/responses/Unauthorized'
3136 $ref: '#/components/responses/Forbidden'
3138 $ref: '#/components/responses/NotFound'
3140 $ref: '#/components/responses/MethodNotAllowed'
3142 $ref: '#/components/responses/NotAcceptable'
3144 $ref: '#/components/responses/Conflict'
3146 $ref: '#/components/responses/UnprocessableEntity'
3148 $ref: '#/components/responses/InternalServerError'
3150 $ref: '#/components/responses/ServiceUnavailable'
3152 $ref: '#/components/responses/UnexpectedError'
3154 $ref: '#/components/responses/UnexpectedError'
3155 '/nsilcm/v1/netslice_instances/{netsliceInstanceId}/instantiate':
3157 - name: netsliceInstanceId
3160 description: NetSlice Instance ID
3165 - "NetSlice instances"
3166 summary: Instantiate a NetSlice
3168 Instantiate a NetSlice. The precondition is that the NetSlice instance
3169 must have been created and must be in NOT_INSTANTIATED state. As a result
3170 of the success of this operation, the NFVO creates a "NetSlice Lifecycle
3171 Operation Occurrence" resource for the request, and the NS instance state
3172 becomes INSTANTIATED.
3173 operationId: instantiateNSI
3175 $ref: '#/components/requestBodies/InstantiateNsiRequest'
3178 description: Accepted
3182 It must point to the new "NetSlice Lifecycle Operation Occurrence"
3183 resource, i.e. an URI like ".../nsi_lcm_op_occs/{nsiLcmOpOccId}"
3190 $ref: '#/components/schemas/ObjectId'
3193 $ref: '#/components/schemas/ObjectId'
3195 $ref: '#/components/responses/BadRequest'
3197 $ref: '#/components/responses/Unauthorized'
3199 $ref: '#/components/responses/Forbidden'
3201 $ref: '#/components/responses/NotFound'
3203 $ref: '#/components/responses/MethodNotAllowed'
3205 $ref: '#/components/responses/NotAcceptable'
3207 $ref: '#/components/responses/Conflict'
3209 $ref: '#/components/responses/UnprocessableEntity'
3211 $ref: '#/components/responses/InternalServerError'
3213 $ref: '#/components/responses/ServiceUnavailable'
3215 $ref: '#/components/responses/UnexpectedError'
3217 $ref: '#/components/responses/UnexpectedError'
3218 '/nsilcm/v1/netslice_instances/{netsliceInstanceId}/terminate':
3220 - name: netsliceInstanceId
3223 description: NetSlice Instance ID
3228 - "NetSlice instances"
3229 summary: Terminate a NetSlice instance
3231 Terminate a NetSlice instance. The precondition is that the NetSlice instance
3232 must have been created and must be in INSTANTIATED state. As a result of the
3233 success of this operation, the NFVO creates a "NetSlice Lifecycle Operation
3234 Occurrence" resource for the request, and the NetSlice instance state becomes
3236 operationId: terminateNSI
3238 # Request data is not required
3239 $ref: '#/components/requestBodies/TerminateNsiRequest'
3242 description: Accepted
3246 It must point to the new "NetSlice Lifecycle Operation Occurrence"
3247 resource, i.e. an URI like ".../nsi_lcm_op_occs/{nsiLcmOpOccId}"
3254 $ref: '#/components/schemas/ObjectId'
3257 $ref: '#/components/schemas/ObjectId'
3259 $ref: '#/components/responses/BadRequest'
3261 $ref: '#/components/responses/Unauthorized'
3263 $ref: '#/components/responses/Forbidden'
3265 $ref: '#/components/responses/NotFound'
3267 $ref: '#/components/responses/MethodNotAllowed'
3269 $ref: '#/components/responses/NotAcceptable'
3271 $ref: '#/components/responses/Conflict'
3273 $ref: '#/components/responses/UnprocessableEntity'
3275 $ref: '#/components/responses/InternalServerError'
3277 $ref: '#/components/responses/ServiceUnavailable'
3279 $ref: '#/components/responses/UnexpectedError'
3281 $ref: '#/components/responses/UnexpectedError'
3282 '/nsilcm/v1/netslice_instances/{netsliceInstanceId}/action':
3284 - name: netsliceInstanceId
3287 description: NetSlice Instance ID
3292 - "NetSlice instances"
3293 summary: Execute an action on a NetSlice instance
3295 Execute an action on a NetSlice instance.
3296 The NetSlice instance must have been created and must be in INSTANTIATED state.
3297 operationId: actionOnNSI
3302 $ref: '#/components/schemas/NsiActionRequest'
3305 $ref: '#/components/schemas/NsiActionRequest'
3308 description: Accepted
3312 It must point to the new "NS Lifecycle Operation Occurrence"
3313 resource, i.e. an URI like ".../ns_lcm_op_occs/{nsLcmOpOccId}"
3320 $ref: '#/components/schemas/ObjectId'
3323 $ref: '#/components/schemas/ObjectId'
3325 $ref: '#/components/responses/BadRequest'
3327 $ref: '#/components/responses/Unauthorized'
3329 $ref: '#/components/responses/Forbidden'
3331 $ref: '#/components/responses/NotFound'
3333 $ref: '#/components/responses/MethodNotAllowed'
3335 $ref: '#/components/responses/NotAcceptable'
3337 $ref: '#/components/responses/Conflict'
3339 $ref: '#/components/responses/UnprocessableEntity'
3341 $ref: '#/components/responses/InternalServerError'
3343 $ref: '#/components/responses/ServiceUnavailable'
3345 $ref: '#/components/responses/UnexpectedError'
3347 $ref: '#/components/responses/UnexpectedError'
3348 '/nsilcm/v1/netslice_instances_content':
3351 - "NetSlice instances"
3352 summary: Query information about multiple NetSlice instances
3353 description: Query information about multiple NetSlice isntances
3354 operationId: getNSIsContent
3361 $ref: '#/components/schemas/ArrayOfNetSliceInstance'
3364 $ref: '#/components/schemas/ArrayOfNetSliceInstance'
3366 $ref: '#/components/responses/BadRequest'
3368 $ref: '#/components/responses/Unauthorized'
3370 $ref: '#/components/responses/Forbidden'
3372 $ref: '#/components/responses/NotFound'
3374 $ref: '#/components/responses/MethodNotAllowed'
3376 $ref: '#/components/responses/NotAcceptable'
3378 $ref: '#/components/responses/Conflict'
3380 $ref: '#/components/responses/UnprocessableEntity'
3382 $ref: '#/components/responses/InternalServerError'
3384 $ref: '#/components/responses/ServiceUnavailable'
3386 $ref: '#/components/responses/UnexpectedError'
3388 $ref: '#/components/responses/UnexpectedError'
3391 - "NetSlice instances"
3392 summary: Create a new NetSlice instance
3393 description: Create a new NetSlice instance
3394 operationId: createNSIContent
3396 $ref: '#/components/requestBodies/InstantiateNsiRequest'
3399 description: Created
3408 $ref: '#/components/schemas/CreateNsiContentResponse'
3411 $ref: '#/components/schemas/CreateNsiContentResponse'
3413 $ref: '#/components/responses/BadRequest'
3415 $ref: '#/components/responses/Unauthorized'
3417 $ref: '#/components/responses/Forbidden'
3419 $ref: '#/components/responses/NotFound'
3421 $ref: '#/components/responses/MethodNotAllowed'
3423 $ref: '#/components/responses/NotAcceptable'
3425 $ref: '#/components/responses/Conflict'
3427 $ref: '#/components/responses/UnprocessableEntity'
3429 $ref: '#/components/responses/InternalServerError'
3431 $ref: '#/components/responses/ServiceUnavailable'
3433 $ref: '#/components/responses/UnexpectedError'
3435 $ref: '#/components/responses/UnexpectedError'
3436 '/nsilcm/v1/netslice_instances_content/{netsliceInstanceContentId}':
3438 - name: netsliceInstanceContentId
3441 description: NetSlice Instance Content ID
3446 - "NetSlice instances"
3447 summary: Read an individual NetSlice instance resource
3448 description: Read an individual NetSlice instance resource
3449 operationId: getNSIContent
3456 $ref: '#/components/schemas/NetSliceInstance'
3459 $ref: '#/components/schemas/NetSliceInstance'
3461 $ref: '#/components/responses/BadRequest'
3463 $ref: '#/components/responses/Unauthorized'
3465 $ref: '#/components/responses/Forbidden'
3467 $ref: '#/components/responses/NotFound'
3469 $ref: '#/components/responses/MethodNotAllowed'
3471 $ref: '#/components/responses/NotAcceptable'
3473 $ref: '#/components/responses/Conflict'
3475 $ref: '#/components/responses/UnprocessableEntity'
3477 $ref: '#/components/responses/InternalServerError'
3479 $ref: '#/components/responses/ServiceUnavailable'
3481 $ref: '#/components/responses/UnexpectedError'
3483 $ref: '#/components/responses/UnexpectedError'
3486 - "NetSlice instances"
3487 summary: Delete an individual NS instance resource
3488 description: Delete an individual NS instance resource
3489 operationId: deleteNSIContent
3492 description: Accepted
3496 $ref: '#/components/schemas/ObjectId'
3499 $ref: '#/components/schemas/ObjectId'
3501 description: No Content
3503 $ref: '#/components/responses/BadRequest'
3505 $ref: '#/components/responses/Unauthorized'
3507 $ref: '#/components/responses/Forbidden'
3509 $ref: '#/components/responses/NotFound'
3511 $ref: '#/components/responses/MethodNotAllowed'
3513 $ref: '#/components/responses/NotAcceptable'
3515 $ref: '#/components/responses/Conflict'
3517 $ref: '#/components/responses/UnprocessableEntity'
3519 $ref: '#/components/responses/InternalServerError'
3521 $ref: '#/components/responses/ServiceUnavailable'
3523 $ref: '#/components/responses/UnexpectedError'
3525 $ref: '#/components/responses/UnexpectedError'
3526 '/nsilcm/v1/nsi_lcm_op_occs':
3529 - "NetSlice instances"
3530 summary: Query information about multiple NetSlice LCM Operation Occurrences
3531 description: Query information about multiple NetSlice LCM Operation Occurrences
3532 operationId: getNsiLcmOpOccs
3539 $ref: '#/components/schemas/ArrayOfNsiLcmOpOcc'
3542 $ref: '#/components/schemas/ArrayOfNsiLcmOpOcc'
3544 $ref: '#/components/responses/BadRequest'
3546 $ref: '#/components/responses/Unauthorized'
3548 $ref: '#/components/responses/Forbidden'
3550 $ref: '#/components/responses/NotFound'
3552 $ref: '#/components/responses/MethodNotAllowed'
3554 $ref: '#/components/responses/NotAcceptable'
3556 $ref: '#/components/responses/Conflict'
3558 $ref: '#/components/responses/UnprocessableEntity'
3560 $ref: '#/components/responses/InternalServerError'
3562 $ref: '#/components/responses/ServiceUnavailable'
3564 $ref: '#/components/responses/UnexpectedError'
3566 $ref: '#/components/responses/UnexpectedError'
3567 '/nsilcm/v1/nsi_lcm_op_occs/{nsiLcmOpOccId}':
3569 - name: nsiLcmOpOccId
3572 description: NetSlice LCM Operation Occurrence ID
3577 - "NetSlice instances"
3578 summary: Query information about an individual NetSlice LCM Operation Occurrence
3579 description: Query information about an individual NetSlice LCM Operation Occurrence
3580 operationId: getNsiLcmOpOcc
3587 $ref: '#/components/schemas/NsiLcmOpOcc'
3590 $ref: '#/components/schemas/NsiLcmOpOcc'
3592 $ref: '#/components/responses/BadRequest'
3594 $ref: '#/components/responses/Unauthorized'
3596 $ref: '#/components/responses/Forbidden'
3598 $ref: '#/components/responses/NotFound'
3600 $ref: '#/components/responses/MethodNotAllowed'
3602 $ref: '#/components/responses/NotAcceptable'
3604 $ref: '#/components/responses/Conflict'
3606 $ref: '#/components/responses/UnprocessableEntity'
3608 $ref: '#/components/responses/InternalServerError'
3610 $ref: '#/components/responses/ServiceUnavailable'
3612 $ref: '#/components/responses/UnexpectedError'
3614 $ref: '#/components/responses/UnexpectedError'
3615 # END NetSlice Instances
3618 '/nspm/v1/pm_jobs/{pmJobId}/reports/{nsId}':
3623 description: NS PM Job ID
3634 - "NS Performance Management"
3635 summary: Query information about an individual NS PM Job Report
3636 description: Query information about an individual NS PM Job Report
3637 operationId: getNsPmJobReport
3644 $ref: '#/components/schemas/NsPmJobReportInfo'
3647 $ref: '#/components/schemas/NsPmJobReportInfo'
3649 $ref: '#/components/responses/BadRequest'
3651 $ref: '#/components/responses/Unauthorized'
3653 $ref: '#/components/responses/Forbidden'
3655 $ref: '#/components/responses/NotFound'
3657 $ref: '#/components/responses/MethodNotAllowed'
3659 $ref: '#/components/responses/NotAcceptable'
3661 $ref: '#/components/responses/Conflict'
3663 $ref: '#/components/responses/UnprocessableEntity'
3665 $ref: '#/components/responses/InternalServerError'
3667 $ref: '#/components/responses/ServiceUnavailable'
3669 $ref: '#/components/responses/UnexpectedError'
3671 $ref: '#/components/responses/UnexpectedError'
3675 '/pdu/v1/pdu_descriptors':
3678 - "Physical Data Units (PDU)"
3679 summary: Query information about multiple PDU Descriptors
3680 description: Query information about multiple PDU Descriptors
3681 operationId: getPDUs
3688 $ref: '#/components/schemas/ArrayOfPduInfo'
3691 $ref: '#/components/schemas/ArrayOfPduInfo'
3693 $ref: '#/components/responses/BadRequest'
3695 $ref: '#/components/responses/Unauthorized'
3697 $ref: '#/components/responses/Forbidden'
3699 $ref: '#/components/responses/NotFound'
3701 $ref: '#/components/responses/MethodNotAllowed'
3703 $ref: '#/components/responses/NotAcceptable'
3705 $ref: '#/components/responses/Conflict'
3707 $ref: '#/components/responses/UnprocessableEntity'
3709 $ref: '#/components/responses/InternalServerError'
3711 $ref: '#/components/responses/ServiceUnavailable'
3713 $ref: '#/components/responses/UnexpectedError'
3715 $ref: '#/components/responses/UnexpectedError'
3718 - "Physical Data Units (PDU)"
3719 summary: Create a new PDU
3720 description: Create a new PDU Descriptor
3721 operationId: createPDU
3723 $ref: '#/components/requestBodies/CreatePduRequest'
3735 $ref: '#/components/schemas/ObjectId'
3738 $ref: '#/components/schemas/ObjectId'
3740 $ref: '#/components/responses/BadRequest'
3742 $ref: '#/components/responses/Unauthorized'
3744 $ref: '#/components/responses/Forbidden'
3746 $ref: '#/components/responses/NotFound'
3748 $ref: '#/components/responses/MethodNotAllowed'
3750 $ref: '#/components/responses/NotAcceptable'
3752 $ref: '#/components/responses/Conflict'
3754 $ref: '#/components/responses/UnprocessableEntity'
3756 $ref: '#/components/responses/InternalServerError'
3758 $ref: '#/components/responses/ServiceUnavailable'
3760 $ref: '#/components/responses/UnexpectedError'
3762 $ref: '#/components/responses/UnexpectedError'
3763 '/pdu/v1/pdu_descriptors/{pduDescriptorId}':
3765 - name: pduDescriptorId
3768 description: PDU Descriptor ID
3773 - "Physical Data Units (PDU)"
3774 summary: Query information about an individual PDU Descriptor
3775 description: Query information about an individual PDU Descriptor
3783 $ref: '#/components/schemas/PduInfo'
3786 $ref: '#/components/schemas/PduInfo'
3788 $ref: '#/components/responses/BadRequest'
3790 $ref: '#/components/responses/Unauthorized'
3792 $ref: '#/components/responses/Forbidden'
3794 $ref: '#/components/responses/NotFound'
3796 $ref: '#/components/responses/MethodNotAllowed'
3798 $ref: '#/components/responses/NotAcceptable'
3800 $ref: '#/components/responses/Conflict'
3802 $ref: '#/components/responses/UnprocessableEntity'
3804 $ref: '#/components/responses/InternalServerError'
3806 $ref: '#/components/responses/ServiceUnavailable'
3808 $ref: '#/components/responses/UnexpectedError'
3810 $ref: '#/components/responses/UnexpectedError'
3813 - "Physical Data Units (PDU)"
3814 summary: Modify an individual PDU Descriptor
3815 description: Modify an individual PDU Descriptor
3816 operationId: editPDU
3818 $ref: '#/components/requestBodies/EditPduRequest'
3821 description: No Content
3823 $ref: '#/components/responses/BadRequest'
3825 $ref: '#/components/responses/Unauthorized'
3827 $ref: '#/components/responses/Forbidden'
3829 $ref: '#/components/responses/NotFound'
3831 $ref: '#/components/responses/MethodNotAllowed'
3833 $ref: '#/components/responses/NotAcceptable'
3835 $ref: '#/components/responses/Conflict'
3837 $ref: '#/components/responses/UnprocessableEntity'
3839 $ref: '#/components/responses/InternalServerError'
3841 $ref: '#/components/responses/ServiceUnavailable'
3843 $ref: '#/components/responses/UnexpectedError'
3845 $ref: '#/components/responses/UnexpectedError'
3848 - "Physical Data Units (PDU)"
3849 summary: Delete an individual PDU Descriptor
3850 description: Delete an individual PDU Descriptor
3851 operationId: deletePDU
3854 description: No Content
3856 $ref: '#/components/responses/BadRequest'
3858 $ref: '#/components/responses/Unauthorized'
3860 $ref: '#/components/responses/Forbidden'
3862 $ref: '#/components/responses/NotFound'
3864 $ref: '#/components/responses/MethodNotAllowed'
3866 $ref: '#/components/responses/NotAcceptable'
3868 $ref: '#/components/responses/Conflict'
3870 $ref: '#/components/responses/UnprocessableEntity'
3872 $ref: '#/components/responses/InternalServerError'
3874 $ref: '#/components/responses/ServiceUnavailable'
3876 $ref: '#/components/responses/UnexpectedError'
3878 $ref: '#/components/responses/UnexpectedError'
3887 summary: Query information about multiple Tokens
3888 description: Query information about multiple Tokens
3889 operationId: getTokens
3896 $ref: '#/components/schemas/ArrayOfTokenInfo'
3899 $ref: '#/components/schemas/ArrayOfTokenInfo'
3901 $ref: '#/components/responses/BadRequest'
3903 $ref: '#/components/responses/Unauthorized'
3905 $ref: '#/components/responses/Forbidden'
3907 $ref: '#/components/responses/NotFound'
3909 $ref: '#/components/responses/MethodNotAllowed'
3911 $ref: '#/components/responses/NotAcceptable'
3913 $ref: '#/components/responses/Conflict'
3915 $ref: '#/components/responses/UnprocessableEntity'
3917 $ref: '#/components/responses/InternalServerError'
3919 $ref: '#/components/responses/ServiceUnavailable'
3921 $ref: '#/components/responses/UnexpectedError'
3923 $ref: '#/components/responses/UnexpectedError'
3928 summary: Request a new Token
3929 description: Request a new Token
3930 operationId: createToken
3932 $ref: '#/components/requestBodies/CreateTokenRequest'
3944 $ref: '#/components/schemas/TokenInfo'
3947 $ref: '#/components/schemas/TokenInfo'
3949 $ref: '#/components/responses/BadRequest'
3951 $ref: '#/components/responses/Unauthorized'
3953 $ref: '#/components/responses/Forbidden'
3955 $ref: '#/components/responses/NotFound'
3957 $ref: '#/components/responses/MethodNotAllowed'
3959 $ref: '#/components/responses/NotAcceptable'
3961 $ref: '#/components/responses/Conflict'
3963 $ref: '#/components/responses/UnprocessableEntity'
3965 $ref: '#/components/responses/InternalServerError'
3967 $ref: '#/components/responses/ServiceUnavailable'
3969 $ref: '#/components/responses/UnexpectedError'
3971 $ref: '#/components/responses/UnexpectedError'
3976 summary: Delete the Token indicated in the Authorization Header
3977 description: Delete the Token indicated in the Authorization Header
3978 operationId: deleteAuthToken
3990 $ref: '#/components/responses/BadRequest'
3992 $ref: '#/components/responses/Unauthorized'
3994 $ref: '#/components/responses/Forbidden'
3996 $ref: '#/components/responses/NotFound'
3998 $ref: '#/components/responses/MethodNotAllowed'
4000 $ref: '#/components/responses/NotAcceptable'
4002 $ref: '#/components/responses/Conflict'
4004 $ref: '#/components/responses/UnprocessableEntity'
4006 $ref: '#/components/responses/InternalServerError'
4008 $ref: '#/components/responses/ServiceUnavailable'
4010 $ref: '#/components/responses/UnexpectedError'
4012 $ref: '#/components/responses/UnexpectedError'
4013 '/admin/v1/tokens/{tokenId}':
4018 description: Token ID
4025 summary: Query information about an individual Token
4026 description: Query information about an individual Token
4027 operationId: getToken
4034 $ref: '#/components/schemas/TokenInfo'
4037 $ref: '#/components/schemas/TokenInfo'
4039 $ref: '#/components/responses/BadRequest'
4041 $ref: '#/components/responses/Unauthorized'
4043 $ref: '#/components/responses/Forbidden'
4045 $ref: '#/components/responses/NotFound'
4047 $ref: '#/components/responses/MethodNotAllowed'
4049 $ref: '#/components/responses/NotAcceptable'
4051 $ref: '#/components/responses/Conflict'
4053 $ref: '#/components/responses/UnprocessableEntity'
4055 $ref: '#/components/responses/InternalServerError'
4057 $ref: '#/components/responses/ServiceUnavailable'
4059 $ref: '#/components/responses/UnexpectedError'
4061 $ref: '#/components/responses/UnexpectedError'
4066 summary: Delete the Token indicated as parameter
4067 description: Delete the Token indicated as parameter
4068 operationId: deleteToken
4080 $ref: '#/components/responses/BadRequest'
4082 $ref: '#/components/responses/Unauthorized'
4084 $ref: '#/components/responses/Forbidden'
4086 $ref: '#/components/responses/NotFound'
4088 $ref: '#/components/responses/MethodNotAllowed'
4090 $ref: '#/components/responses/NotAcceptable'
4092 $ref: '#/components/responses/Conflict'
4094 $ref: '#/components/responses/UnprocessableEntity'
4096 $ref: '#/components/responses/InternalServerError'
4098 $ref: '#/components/responses/ServiceUnavailable'
4100 $ref: '#/components/responses/UnexpectedError'
4102 $ref: '#/components/responses/UnexpectedError'
4108 summary: Query information about multiple Users
4109 description: Query information about multiple Users
4110 operationId: getUsers
4117 $ref: '#/components/schemas/ArrayOfUserInfo'
4120 $ref: '#/components/schemas/ArrayOfUserInfo'
4122 $ref: '#/components/responses/BadRequest'
4124 $ref: '#/components/responses/Unauthorized'
4126 $ref: '#/components/responses/Forbidden'
4128 $ref: '#/components/responses/NotFound'
4130 $ref: '#/components/responses/MethodNotAllowed'
4132 $ref: '#/components/responses/NotAcceptable'
4134 $ref: '#/components/responses/Conflict'
4136 $ref: '#/components/responses/UnprocessableEntity'
4138 $ref: '#/components/responses/InternalServerError'
4140 $ref: '#/components/responses/ServiceUnavailable'
4142 $ref: '#/components/responses/UnexpectedError'
4144 $ref: '#/components/responses/UnexpectedError'
4149 summary: Create a new User
4150 description: Create a new User
4151 operationId: createUser
4153 $ref: '#/components/requestBodies/CreateUserRequest'
4156 description: Created
4165 $ref: '#/components/schemas/ObjectId'
4168 $ref: '#/components/schemas/ObjectId'
4170 $ref: '#/components/responses/BadRequest'
4172 $ref: '#/components/responses/Unauthorized'
4174 $ref: '#/components/responses/Forbidden'
4176 $ref: '#/components/responses/NotFound'
4178 $ref: '#/components/responses/MethodNotAllowed'
4180 $ref: '#/components/responses/NotAcceptable'
4182 $ref: '#/components/responses/Conflict'
4184 $ref: '#/components/responses/UnprocessableEntity'
4186 $ref: '#/components/responses/InternalServerError'
4188 $ref: '#/components/responses/ServiceUnavailable'
4190 $ref: '#/components/responses/UnexpectedError'
4192 $ref: '#/components/responses/UnexpectedError'
4193 '/admin/v1/users/{userId}':
4198 description: User ID/Name
4205 summary: Query information about an individual User
4206 description: Query information about an individual User
4207 operationId: getUser
4214 $ref: '#/components/schemas/UserInfo'
4217 $ref: '#/components/schemas/UserInfo'
4219 $ref: '#/components/responses/BadRequest'
4221 $ref: '#/components/responses/Unauthorized'
4223 $ref: '#/components/responses/Forbidden'
4225 $ref: '#/components/responses/NotFound'
4227 $ref: '#/components/responses/MethodNotAllowed'
4229 $ref: '#/components/responses/NotAcceptable'
4231 $ref: '#/components/responses/Conflict'
4233 $ref: '#/components/responses/UnprocessableEntity'
4235 $ref: '#/components/responses/InternalServerError'
4237 $ref: '#/components/responses/ServiceUnavailable'
4239 $ref: '#/components/responses/UnexpectedError'
4241 $ref: '#/components/responses/UnexpectedError'
4246 summary: Modify a User
4247 description: Modify a User
4248 operationId: editUser
4250 $ref: '#/components/requestBodies/EditUserRequest'
4253 description: No Content
4255 $ref: '#/components/responses/BadRequest'
4257 $ref: '#/components/responses/Unauthorized'
4259 $ref: '#/components/responses/Forbidden'
4261 $ref: '#/components/responses/NotFound'
4263 $ref: '#/components/responses/MethodNotAllowed'
4265 $ref: '#/components/responses/NotAcceptable'
4267 $ref: '#/components/responses/Conflict'
4269 $ref: '#/components/responses/UnprocessableEntity'
4271 $ref: '#/components/responses/InternalServerError'
4273 $ref: '#/components/responses/ServiceUnavailable'
4275 $ref: '#/components/responses/UnexpectedError'
4277 $ref: '#/components/responses/UnexpectedError'
4282 summary: Delete a User
4283 description: Delete a User
4284 operationId: deleteUser
4287 description: No Content
4289 $ref: '#/components/responses/BadRequest'
4291 $ref: '#/components/responses/Unauthorized'
4293 $ref: '#/components/responses/Forbidden'
4295 $ref: '#/components/responses/NotFound'
4297 $ref: '#/components/responses/MethodNotAllowed'
4299 $ref: '#/components/responses/NotAcceptable'
4301 $ref: '#/components/responses/Conflict'
4303 $ref: '#/components/responses/UnprocessableEntity'
4305 $ref: '#/components/responses/InternalServerError'
4307 $ref: '#/components/responses/ServiceUnavailable'
4309 $ref: '#/components/responses/UnexpectedError'
4311 $ref: '#/components/responses/UnexpectedError'
4312 '/admin/v1/projects':
4317 summary: Query information about multiple Projects
4318 description: Query information about multiple Projects
4319 operationId: getProjects
4326 $ref: '#/components/schemas/ArrayOfProjectInfo'
4329 $ref: '#/components/schemas/ArrayOfProjectInfo'
4331 $ref: '#/components/responses/BadRequest'
4333 $ref: '#/components/responses/Unauthorized'
4335 $ref: '#/components/responses/Forbidden'
4337 $ref: '#/components/responses/NotFound'
4339 $ref: '#/components/responses/MethodNotAllowed'
4341 $ref: '#/components/responses/NotAcceptable'
4343 $ref: '#/components/responses/Conflict'
4345 $ref: '#/components/responses/UnprocessableEntity'
4347 $ref: '#/components/responses/InternalServerError'
4349 $ref: '#/components/responses/ServiceUnavailable'
4351 $ref: '#/components/responses/UnexpectedError'
4353 $ref: '#/components/responses/UnexpectedError'
4358 summary: Create a new Project
4359 description: Create a new Project
4360 operationId: createProject
4362 $ref: '#/components/requestBodies/CreateProjectRequest'
4365 description: Created
4374 $ref: '#/components/schemas/ObjectId'
4377 $ref: '#/components/schemas/ObjectId'
4379 $ref: '#/components/responses/BadRequest'
4381 $ref: '#/components/responses/Unauthorized'
4383 $ref: '#/components/responses/Forbidden'
4385 $ref: '#/components/responses/NotFound'
4387 $ref: '#/components/responses/MethodNotAllowed'
4389 $ref: '#/components/responses/NotAcceptable'
4391 $ref: '#/components/responses/Conflict'
4393 $ref: '#/components/responses/UnprocessableEntity'
4395 $ref: '#/components/responses/InternalServerError'
4397 $ref: '#/components/responses/ServiceUnavailable'
4399 $ref: '#/components/responses/UnexpectedError'
4401 $ref: '#/components/responses/UnexpectedError'
4402 '/admin/v1/projects/{projectId}':
4407 description: Project ID/Name
4414 summary: Query information about an individual Project
4415 description: Query information about an individual Project
4416 operationId: getProject
4423 $ref: '#/components/schemas/ProjectInfo'
4426 $ref: '#/components/schemas/ProjectInfo'
4428 $ref: '#/components/responses/BadRequest'
4430 $ref: '#/components/responses/Unauthorized'
4432 $ref: '#/components/responses/Forbidden'
4434 $ref: '#/components/responses/NotFound'
4436 $ref: '#/components/responses/MethodNotAllowed'
4438 $ref: '#/components/responses/NotAcceptable'
4440 $ref: '#/components/responses/Conflict'
4442 $ref: '#/components/responses/UnprocessableEntity'
4444 $ref: '#/components/responses/InternalServerError'
4446 $ref: '#/components/responses/ServiceUnavailable'
4448 $ref: '#/components/responses/UnexpectedError'
4450 $ref: '#/components/responses/UnexpectedError'
4455 summary: Modify a Project
4456 description: Modify a Project
4457 operationId: editProject
4459 $ref: '#/components/requestBodies/EditProjectRequest'
4462 description: No Content
4464 $ref: '#/components/responses/BadRequest'
4466 $ref: '#/components/responses/Unauthorized'
4468 $ref: '#/components/responses/Forbidden'
4470 $ref: '#/components/responses/NotFound'
4472 $ref: '#/components/responses/MethodNotAllowed'
4474 $ref: '#/components/responses/NotAcceptable'
4476 $ref: '#/components/responses/Conflict'
4478 $ref: '#/components/responses/UnprocessableEntity'
4480 $ref: '#/components/responses/InternalServerError'
4482 $ref: '#/components/responses/ServiceUnavailable'
4484 $ref: '#/components/responses/UnexpectedError'
4486 $ref: '#/components/responses/UnexpectedError'
4491 summary: Delete a Project
4492 description: Delete a Project
4493 operationId: deleteProject
4496 description: No Content
4498 $ref: '#/components/responses/BadRequest'
4500 $ref: '#/components/responses/Unauthorized'
4502 $ref: '#/components/responses/Forbidden'
4504 $ref: '#/components/responses/NotFound'
4506 $ref: '#/components/responses/MethodNotAllowed'
4508 $ref: '#/components/responses/NotAcceptable'
4510 $ref: '#/components/responses/Conflict'
4512 $ref: '#/components/responses/UnprocessableEntity'
4514 $ref: '#/components/responses/InternalServerError'
4516 $ref: '#/components/responses/ServiceUnavailable'
4518 $ref: '#/components/responses/UnexpectedError'
4520 $ref: '#/components/responses/UnexpectedError'
4526 summary: Query information about multiple Roles
4527 description: Query information about multiple Roles
4528 operationId: getRoles
4535 $ref: '#/components/schemas/ArrayOfRoleInfo'
4538 $ref: '#/components/schemas/ArrayOfRoleInfo'
4540 $ref: '#/components/responses/BadRequest'
4542 $ref: '#/components/responses/Unauthorized'
4544 $ref: '#/components/responses/Forbidden'
4546 $ref: '#/components/responses/NotFound'
4548 $ref: '#/components/responses/MethodNotAllowed'
4550 $ref: '#/components/responses/NotAcceptable'
4552 $ref: '#/components/responses/Conflict'
4554 $ref: '#/components/responses/UnprocessableEntity'
4556 $ref: '#/components/responses/InternalServerError'
4558 $ref: '#/components/responses/ServiceUnavailable'
4560 $ref: '#/components/responses/UnexpectedError'
4562 $ref: '#/components/responses/UnexpectedError'
4567 summary: Create a new Role
4568 description: Create a new Role
4569 operationId: createRole
4571 $ref: '#/components/requestBodies/CreateRoleRequest'
4574 description: Created
4583 $ref: '#/components/schemas/ObjectId'
4586 $ref: '#/components/schemas/ObjectId'
4588 $ref: '#/components/responses/BadRequest'
4590 $ref: '#/components/responses/Unauthorized'
4592 $ref: '#/components/responses/Forbidden'
4594 $ref: '#/components/responses/NotFound'
4596 $ref: '#/components/responses/MethodNotAllowed'
4598 $ref: '#/components/responses/NotAcceptable'
4600 $ref: '#/components/responses/Conflict'
4602 $ref: '#/components/responses/UnprocessableEntity'
4604 $ref: '#/components/responses/InternalServerError'
4606 $ref: '#/components/responses/ServiceUnavailable'
4608 $ref: '#/components/responses/UnexpectedError'
4610 $ref: '#/components/responses/UnexpectedError'
4611 '/admin/v1/roles/{roleId}':
4616 description: Role ID/Name
4623 summary: Query information about an individual Role
4624 description: Query information about an individual Role
4625 operationId: getRole
4632 $ref: '#/components/schemas/RoleInfo'
4635 $ref: '#/components/schemas/RoleInfo'
4637 $ref: '#/components/responses/BadRequest'
4639 $ref: '#/components/responses/Unauthorized'
4641 $ref: '#/components/responses/Forbidden'
4643 $ref: '#/components/responses/NotFound'
4645 $ref: '#/components/responses/MethodNotAllowed'
4647 $ref: '#/components/responses/NotAcceptable'
4649 $ref: '#/components/responses/Conflict'
4651 $ref: '#/components/responses/UnprocessableEntity'
4653 $ref: '#/components/responses/InternalServerError'
4655 $ref: '#/components/responses/ServiceUnavailable'
4657 $ref: '#/components/responses/UnexpectedError'
4659 $ref: '#/components/responses/UnexpectedError'
4664 summary: Modify a Role
4665 description: Modify a Role
4666 operationId: editRole
4668 $ref: '#/components/requestBodies/EditRoleRequest'
4671 description: No Content
4673 $ref: '#/components/responses/BadRequest'
4675 $ref: '#/components/responses/Unauthorized'
4677 $ref: '#/components/responses/Forbidden'
4679 $ref: '#/components/responses/NotFound'
4681 $ref: '#/components/responses/MethodNotAllowed'
4683 $ref: '#/components/responses/NotAcceptable'
4685 $ref: '#/components/responses/Conflict'
4687 $ref: '#/components/responses/UnprocessableEntity'
4689 $ref: '#/components/responses/InternalServerError'
4691 $ref: '#/components/responses/ServiceUnavailable'
4693 $ref: '#/components/responses/UnexpectedError'
4695 $ref: '#/components/responses/UnexpectedError'
4700 summary: Delete a Role
4701 description: Delete a Role
4702 operationId: deleteRole
4705 description: No Content
4707 $ref: '#/components/responses/BadRequest'
4709 $ref: '#/components/responses/Unauthorized'
4711 $ref: '#/components/responses/Forbidden'
4713 $ref: '#/components/responses/NotFound'
4715 $ref: '#/components/responses/MethodNotAllowed'
4717 $ref: '#/components/responses/NotAcceptable'
4719 $ref: '#/components/responses/Conflict'
4721 $ref: '#/components/responses/UnprocessableEntity'
4723 $ref: '#/components/responses/InternalServerError'
4725 $ref: '#/components/responses/ServiceUnavailable'
4727 $ref: '#/components/responses/UnexpectedError'
4729 $ref: '#/components/responses/UnexpectedError'
4735 summary: Query information about multiple VIMs
4736 description: Query information about multiple VIMs
4737 operationId: getVIMs
4744 $ref: '#/components/schemas/ArrayOfVimInfo'
4747 $ref: '#/components/schemas/ArrayOfVimInfo'
4749 $ref: '#/components/responses/BadRequest'
4751 $ref: '#/components/responses/Unauthorized'
4753 $ref: '#/components/responses/Forbidden'
4755 $ref: '#/components/responses/NotFound'
4757 $ref: '#/components/responses/MethodNotAllowed'
4759 $ref: '#/components/responses/NotAcceptable'
4761 $ref: '#/components/responses/Conflict'
4763 $ref: '#/components/responses/UnprocessableEntity'
4765 $ref: '#/components/responses/InternalServerError'
4767 $ref: '#/components/responses/ServiceUnavailable'
4769 $ref: '#/components/responses/UnexpectedError'
4771 $ref: '#/components/responses/UnexpectedError'
4776 summary: Create a new VIM
4777 description: Create a new VIM
4778 operationId: createVIM
4780 $ref: '#/components/requestBodies/CreateVimRequest'
4783 description: Accepted
4787 $ref: '#/components/schemas/ObjectId_plus_OpId'
4790 $ref: '#/components/schemas/ObjectId_plus_OpId'
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/vims/{vimId}':
4828 summary: Query information about an individual VIM
4829 description: Query information about an individual VIM
4837 $ref: '#/components/schemas/VimInfo'
4840 $ref: '#/components/schemas/VimInfo'
4842 $ref: '#/components/responses/BadRequest'
4844 $ref: '#/components/responses/Unauthorized'
4846 $ref: '#/components/responses/Forbidden'
4848 $ref: '#/components/responses/NotFound'
4850 $ref: '#/components/responses/MethodNotAllowed'
4852 $ref: '#/components/responses/NotAcceptable'
4854 $ref: '#/components/responses/Conflict'
4856 $ref: '#/components/responses/UnprocessableEntity'
4858 $ref: '#/components/responses/InternalServerError'
4860 $ref: '#/components/responses/ServiceUnavailable'
4862 $ref: '#/components/responses/UnexpectedError'
4864 $ref: '#/components/responses/UnexpectedError'
4869 summary: Modify a VIM
4870 description: Modify a VIM
4871 operationId: editVIM
4873 $ref: '#/components/requestBodies/EditVimRequest'
4876 description: Accepted
4880 $ref: '#/components/schemas/OpId'
4883 $ref: '#/components/schemas/OpId'
4885 $ref: '#/components/responses/BadRequest'
4887 $ref: '#/components/responses/Unauthorized'
4889 $ref: '#/components/responses/Forbidden'
4891 $ref: '#/components/responses/NotFound'
4893 $ref: '#/components/responses/MethodNotAllowed'
4895 $ref: '#/components/responses/NotAcceptable'
4897 $ref: '#/components/responses/Conflict'
4899 $ref: '#/components/responses/UnprocessableEntity'
4901 $ref: '#/components/responses/InternalServerError'
4903 $ref: '#/components/responses/ServiceUnavailable'
4905 $ref: '#/components/responses/UnexpectedError'
4907 $ref: '#/components/responses/UnexpectedError'
4912 summary: Delete a VIM
4913 description: Delete a VIM
4914 operationId: deleteVIM
4917 description: Accepted
4919 $ref: '#/components/responses/BadRequest'
4921 $ref: '#/components/responses/Unauthorized'
4923 $ref: '#/components/responses/Forbidden'
4925 $ref: '#/components/responses/NotFound'
4927 $ref: '#/components/responses/MethodNotAllowed'
4929 $ref: '#/components/responses/NotAcceptable'
4931 $ref: '#/components/responses/Conflict'
4933 $ref: '#/components/responses/UnprocessableEntity'
4935 $ref: '#/components/responses/InternalServerError'
4937 $ref: '#/components/responses/ServiceUnavailable'
4939 $ref: '#/components/responses/UnexpectedError'
4941 $ref: '#/components/responses/UnexpectedError'
4942 '/admin/v1/vim_accounts':
4947 summary: Query information about multiple VIM Accounts
4948 description: Query information about multiple VIM Accounts
4949 operationId: getVimAccounts
4956 $ref: '#/components/schemas/ArrayOfVimInfo'
4959 $ref: '#/components/schemas/ArrayOfVimInfo'
4961 $ref: '#/components/responses/BadRequest'
4963 $ref: '#/components/responses/Unauthorized'
4965 $ref: '#/components/responses/Forbidden'
4967 $ref: '#/components/responses/NotFound'
4969 $ref: '#/components/responses/MethodNotAllowed'
4971 $ref: '#/components/responses/NotAcceptable'
4973 $ref: '#/components/responses/Conflict'
4975 $ref: '#/components/responses/UnprocessableEntity'
4977 $ref: '#/components/responses/InternalServerError'
4979 $ref: '#/components/responses/ServiceUnavailable'
4981 $ref: '#/components/responses/UnexpectedError'
4983 $ref: '#/components/responses/UnexpectedError'
4988 summary: Create a new VIM Account
4989 description: Create a new VIM Account
4990 operationId: createVimAccount
4992 $ref: '#/components/requestBodies/CreateVimRequest'
4995 description: Accepted
4999 $ref: '#/components/schemas/ObjectId_plus_OpId'
5002 $ref: '#/components/schemas/ObjectId_plus_OpId'
5004 $ref: '#/components/responses/BadRequest'
5006 $ref: '#/components/responses/Unauthorized'
5008 $ref: '#/components/responses/Forbidden'
5010 $ref: '#/components/responses/NotFound'
5012 $ref: '#/components/responses/MethodNotAllowed'
5014 $ref: '#/components/responses/NotAcceptable'
5016 $ref: '#/components/responses/Conflict'
5018 $ref: '#/components/responses/UnprocessableEntity'
5020 $ref: '#/components/responses/InternalServerError'
5022 $ref: '#/components/responses/ServiceUnavailable'
5024 $ref: '#/components/responses/UnexpectedError'
5026 $ref: '#/components/responses/UnexpectedError'
5027 '/admin/v1/vim_accounts/{vimAccountId}':
5029 - name: vimAccountId
5032 description: VIM Account ID
5040 summary: Query information about an individual VIM Account
5041 description: Query information about an individual VIM Account
5042 operationId: getVimAccount
5049 $ref: '#/components/schemas/VimInfo'
5052 $ref: '#/components/schemas/VimInfo'
5054 $ref: '#/components/responses/BadRequest'
5056 $ref: '#/components/responses/Unauthorized'
5058 $ref: '#/components/responses/Forbidden'
5060 $ref: '#/components/responses/NotFound'
5062 $ref: '#/components/responses/MethodNotAllowed'
5064 $ref: '#/components/responses/NotAcceptable'
5066 $ref: '#/components/responses/Conflict'
5068 $ref: '#/components/responses/UnprocessableEntity'
5070 $ref: '#/components/responses/InternalServerError'
5072 $ref: '#/components/responses/ServiceUnavailable'
5074 $ref: '#/components/responses/UnexpectedError'
5076 $ref: '#/components/responses/UnexpectedError'
5081 summary: Modify a VIM Account
5082 description: Modify a VIM Account
5083 operationId: editVimAccount
5085 $ref: '#/components/requestBodies/EditVimRequest'
5088 description: Accepted
5092 $ref: '#/components/schemas/OpId'
5095 $ref: '#/components/schemas/OpId'
5097 $ref: '#/components/responses/BadRequest'
5099 $ref: '#/components/responses/Unauthorized'
5101 $ref: '#/components/responses/Forbidden'
5103 $ref: '#/components/responses/NotFound'
5105 $ref: '#/components/responses/MethodNotAllowed'
5107 $ref: '#/components/responses/NotAcceptable'
5109 $ref: '#/components/responses/Conflict'
5111 $ref: '#/components/responses/UnprocessableEntity'
5113 $ref: '#/components/responses/InternalServerError'
5115 $ref: '#/components/responses/ServiceUnavailable'
5117 $ref: '#/components/responses/UnexpectedError'
5119 $ref: '#/components/responses/UnexpectedError'
5124 summary: Delete a VIM Account
5125 description: Delete a VIM Account
5126 operationId: deleteVimAccount
5129 description: Accepted
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'
5154 '/admin/v1/wim_accounts':
5159 summary: Query information about multiple WIM Accounts
5160 description: Query information about multiple WIM Accounts
5161 operationId: getWimAccounts
5168 $ref: '#/components/schemas/ArrayOfWimInfo'
5171 $ref: '#/components/schemas/ArrayOfWimInfo'
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'
5200 summary: Create a new WIM Account
5201 description: Create a new WIM Account
5202 operationId: createWimAccount
5204 $ref: '#/components/requestBodies/CreateWimRequest'
5207 description: Accepted
5211 $ref: '#/components/schemas/ObjectId_plus_OpId'
5214 $ref: '#/components/schemas/ObjectId_plus_OpId'
5216 $ref: '#/components/responses/BadRequest'
5218 $ref: '#/components/responses/Unauthorized'
5220 $ref: '#/components/responses/Forbidden'
5222 $ref: '#/components/responses/NotFound'
5224 $ref: '#/components/responses/MethodNotAllowed'
5226 $ref: '#/components/responses/NotAcceptable'
5228 $ref: '#/components/responses/Conflict'
5230 $ref: '#/components/responses/UnprocessableEntity'
5232 $ref: '#/components/responses/InternalServerError'
5234 $ref: '#/components/responses/ServiceUnavailable'
5236 $ref: '#/components/responses/UnexpectedError'
5238 $ref: '#/components/responses/UnexpectedError'
5239 '/admin/v1/wim_accounts/{wimAccountId}':
5241 - name: wimAccountId
5244 description: WIM Account ID
5252 summary: Query information about an individual WIM Account
5253 description: Query information about an individual WIM Account
5254 operationId: getWimAccount
5261 $ref: '#/components/schemas/WimInfo'
5264 $ref: '#/components/schemas/WimInfo'
5266 $ref: '#/components/responses/BadRequest'
5268 $ref: '#/components/responses/Unauthorized'
5270 $ref: '#/components/responses/Forbidden'
5272 $ref: '#/components/responses/NotFound'
5274 $ref: '#/components/responses/MethodNotAllowed'
5276 $ref: '#/components/responses/NotAcceptable'
5278 $ref: '#/components/responses/Conflict'
5280 $ref: '#/components/responses/UnprocessableEntity'
5282 $ref: '#/components/responses/InternalServerError'
5284 $ref: '#/components/responses/ServiceUnavailable'
5286 $ref: '#/components/responses/UnexpectedError'
5288 $ref: '#/components/responses/UnexpectedError'
5293 summary: Modify a WIM Account
5294 description: Modify a WIM Account
5295 operationId: editWimAccount
5297 $ref: '#/components/requestBodies/EditWimRequest'
5300 description: Accepted
5304 $ref: '#/components/schemas/OpId'
5307 $ref: '#/components/schemas/OpId'
5309 $ref: '#/components/responses/BadRequest'
5311 $ref: '#/components/responses/Unauthorized'
5313 $ref: '#/components/responses/Forbidden'
5315 $ref: '#/components/responses/NotFound'
5317 $ref: '#/components/responses/MethodNotAllowed'
5319 $ref: '#/components/responses/NotAcceptable'
5321 $ref: '#/components/responses/Conflict'
5323 $ref: '#/components/responses/UnprocessableEntity'
5325 $ref: '#/components/responses/InternalServerError'
5327 $ref: '#/components/responses/ServiceUnavailable'
5329 $ref: '#/components/responses/UnexpectedError'
5331 $ref: '#/components/responses/UnexpectedError'
5336 summary: Delete a WIM Account
5337 description: Delete a WIM Account
5338 operationId: deleteWimAccount
5341 description: Accepted
5343 $ref: '#/components/responses/BadRequest'
5345 $ref: '#/components/responses/Unauthorized'
5347 $ref: '#/components/responses/Forbidden'
5349 $ref: '#/components/responses/NotFound'
5351 $ref: '#/components/responses/MethodNotAllowed'
5353 $ref: '#/components/responses/NotAcceptable'
5355 $ref: '#/components/responses/Conflict'
5357 $ref: '#/components/responses/UnprocessableEntity'
5359 $ref: '#/components/responses/InternalServerError'
5361 $ref: '#/components/responses/ServiceUnavailable'
5363 $ref: '#/components/responses/UnexpectedError'
5365 $ref: '#/components/responses/UnexpectedError'
5371 summary: Query information about multiple SDNs
5372 description: Query information about multiple SDNs
5373 operationId: getSDNs
5380 $ref: '#/components/schemas/ArrayOfSdnInfo'
5383 $ref: '#/components/schemas/ArrayOfSdnInfo'
5385 $ref: '#/components/responses/BadRequest'
5387 $ref: '#/components/responses/Unauthorized'
5389 $ref: '#/components/responses/Forbidden'
5391 $ref: '#/components/responses/NotFound'
5393 $ref: '#/components/responses/MethodNotAllowed'
5395 $ref: '#/components/responses/NotAcceptable'
5397 $ref: '#/components/responses/Conflict'
5399 $ref: '#/components/responses/UnprocessableEntity'
5401 $ref: '#/components/responses/InternalServerError'
5403 $ref: '#/components/responses/ServiceUnavailable'
5405 $ref: '#/components/responses/UnexpectedError'
5407 $ref: '#/components/responses/UnexpectedError'
5412 summary: Create a new SDN
5413 description: Create a new SDN
5414 operationId: createSDN
5416 $ref: '#/components/requestBodies/CreateSdnRequest'
5419 description: Accepted
5423 $ref: '#/components/schemas/ObjectId_plus_OpId'
5426 $ref: '#/components/schemas/ObjectId_plus_OpId'
5428 $ref: '#/components/responses/BadRequest'
5430 $ref: '#/components/responses/Unauthorized'
5432 $ref: '#/components/responses/Forbidden'
5434 $ref: '#/components/responses/NotFound'
5436 $ref: '#/components/responses/MethodNotAllowed'
5438 $ref: '#/components/responses/NotAcceptable'
5440 $ref: '#/components/responses/Conflict'
5442 $ref: '#/components/responses/UnprocessableEntity'
5444 $ref: '#/components/responses/InternalServerError'
5446 $ref: '#/components/responses/ServiceUnavailable'
5448 $ref: '#/components/responses/UnexpectedError'
5450 $ref: '#/components/responses/UnexpectedError'
5451 '/admin/v1/sdns/{sdnId}':
5464 summary: Query information about an individual SDN
5465 description: Query information about an individual SDN
5473 $ref: '#/components/schemas/SdnInfo'
5476 $ref: '#/components/schemas/SdnInfo'
5478 $ref: '#/components/responses/BadRequest'
5480 $ref: '#/components/responses/Unauthorized'
5482 $ref: '#/components/responses/Forbidden'
5484 $ref: '#/components/responses/NotFound'
5486 $ref: '#/components/responses/MethodNotAllowed'
5488 $ref: '#/components/responses/NotAcceptable'
5490 $ref: '#/components/responses/Conflict'
5492 $ref: '#/components/responses/UnprocessableEntity'
5494 $ref: '#/components/responses/InternalServerError'
5496 $ref: '#/components/responses/ServiceUnavailable'
5498 $ref: '#/components/responses/UnexpectedError'
5500 $ref: '#/components/responses/UnexpectedError'
5505 summary: Modify a SDN
5506 description: Modify a SDN
5507 operationId: editSDN
5509 $ref: '#/components/requestBodies/EditSdnRequest'
5512 description: Accepted
5516 $ref: '#/components/schemas/OpId'
5519 $ref: '#/components/schemas/OpId'
5521 $ref: '#/components/responses/BadRequest'
5523 $ref: '#/components/responses/Unauthorized'
5525 $ref: '#/components/responses/Forbidden'
5527 $ref: '#/components/responses/NotFound'
5529 $ref: '#/components/responses/MethodNotAllowed'
5531 $ref: '#/components/responses/NotAcceptable'
5533 $ref: '#/components/responses/Conflict'
5535 $ref: '#/components/responses/UnprocessableEntity'
5537 $ref: '#/components/responses/InternalServerError'
5539 $ref: '#/components/responses/ServiceUnavailable'
5541 $ref: '#/components/responses/UnexpectedError'
5543 $ref: '#/components/responses/UnexpectedError'
5548 summary: Delete a SDN
5549 description: Delete a SDN
5550 operationId: deleteSDN
5553 description: Accepted
5555 $ref: '#/components/responses/BadRequest'
5557 $ref: '#/components/responses/Unauthorized'
5559 $ref: '#/components/responses/Forbidden'
5561 $ref: '#/components/responses/NotFound'
5563 $ref: '#/components/responses/MethodNotAllowed'
5565 $ref: '#/components/responses/NotAcceptable'
5567 $ref: '#/components/responses/Conflict'
5569 $ref: '#/components/responses/UnprocessableEntity'
5571 $ref: '#/components/responses/InternalServerError'
5573 $ref: '#/components/responses/ServiceUnavailable'
5575 $ref: '#/components/responses/UnexpectedError'
5577 $ref: '#/components/responses/UnexpectedError'
5578 '/admin/v1/k8sclusters':
5583 summary: Query information about multiple K8s Clusters
5584 description: Query information about multiple K8s Clusters
5585 operationId: getK8sClusters
5592 $ref: '#/components/schemas/ArrayOfK8sClusterInfo'
5595 $ref: '#/components/schemas/ArrayOfK8sClusterInfo'
5597 $ref: '#/components/responses/BadRequest'
5599 $ref: '#/components/responses/Unauthorized'
5601 $ref: '#/components/responses/Forbidden'
5603 $ref: '#/components/responses/NotFound'
5605 $ref: '#/components/responses/MethodNotAllowed'
5607 $ref: '#/components/responses/NotAcceptable'
5609 $ref: '#/components/responses/Conflict'
5611 $ref: '#/components/responses/UnprocessableEntity'
5613 $ref: '#/components/responses/InternalServerError'
5615 $ref: '#/components/responses/ServiceUnavailable'
5617 $ref: '#/components/responses/UnexpectedError'
5619 $ref: '#/components/responses/UnexpectedError'
5624 summary: Create a new K8s Cluster
5625 description: Create a new K8s Cluster
5626 operationId: createK8sCluster
5628 $ref: '#/components/requestBodies/CreateK8sClusterRequest'
5631 description: Accepted
5635 $ref: '#/components/schemas/ObjectId_plus_OpId'
5638 $ref: '#/components/schemas/ObjectId_plus_OpId'
5640 $ref: '#/components/responses/BadRequest'
5642 $ref: '#/components/responses/Unauthorized'
5644 $ref: '#/components/responses/Forbidden'
5646 $ref: '#/components/responses/NotFound'
5648 $ref: '#/components/responses/MethodNotAllowed'
5650 $ref: '#/components/responses/NotAcceptable'
5652 $ref: '#/components/responses/Conflict'
5654 $ref: '#/components/responses/UnprocessableEntity'
5656 $ref: '#/components/responses/InternalServerError'
5658 $ref: '#/components/responses/ServiceUnavailable'
5660 $ref: '#/components/responses/UnexpectedError'
5662 $ref: '#/components/responses/UnexpectedError'
5663 '/admin/v1/k8sclusters/{k8sClusterId}':
5665 - name: k8sClusterId
5668 description: K8s Cluster ID
5676 summary: Query information about an individual K8s Cluster
5677 description: Query information about an individual K8s Cluster
5678 operationId: getK8sCluster
5685 $ref: '#/components/schemas/K8sClusterInfo'
5688 $ref: '#/components/schemas/K8sClusterInfo'
5690 $ref: '#/components/responses/BadRequest'
5692 $ref: '#/components/responses/Unauthorized'
5694 $ref: '#/components/responses/Forbidden'
5696 $ref: '#/components/responses/NotFound'
5698 $ref: '#/components/responses/MethodNotAllowed'
5700 $ref: '#/components/responses/NotAcceptable'
5702 $ref: '#/components/responses/Conflict'
5704 $ref: '#/components/responses/UnprocessableEntity'
5706 $ref: '#/components/responses/InternalServerError'
5708 $ref: '#/components/responses/ServiceUnavailable'
5710 $ref: '#/components/responses/UnexpectedError'
5712 $ref: '#/components/responses/UnexpectedError'
5717 summary: Modify a K8s Cluster
5718 description: Modify a K8s Cluster
5719 operationId: editK8sCluster
5721 $ref: '#/components/requestBodies/EditK8sClusterRequest'
5724 description: Accepted
5728 $ref: '#/components/schemas/OpId'
5731 $ref: '#/components/schemas/OpId'
5733 $ref: '#/components/responses/BadRequest'
5735 $ref: '#/components/responses/Unauthorized'
5737 $ref: '#/components/responses/Forbidden'
5739 $ref: '#/components/responses/NotFound'
5741 $ref: '#/components/responses/MethodNotAllowed'
5743 $ref: '#/components/responses/NotAcceptable'
5745 $ref: '#/components/responses/Conflict'
5747 $ref: '#/components/responses/UnprocessableEntity'
5749 $ref: '#/components/responses/InternalServerError'
5751 $ref: '#/components/responses/ServiceUnavailable'
5753 $ref: '#/components/responses/UnexpectedError'
5755 $ref: '#/components/responses/UnexpectedError'
5760 summary: Delete a K8s Cluster
5761 description: Delete a K8s Cluster
5762 operationId: deleteK8sCluster
5765 description: Accepted
5767 $ref: '#/components/responses/BadRequest'
5769 $ref: '#/components/responses/Unauthorized'
5771 $ref: '#/components/responses/Forbidden'
5773 $ref: '#/components/responses/NotFound'
5775 $ref: '#/components/responses/MethodNotAllowed'
5777 $ref: '#/components/responses/NotAcceptable'
5779 $ref: '#/components/responses/Conflict'
5781 $ref: '#/components/responses/UnprocessableEntity'
5783 $ref: '#/components/responses/InternalServerError'
5785 $ref: '#/components/responses/ServiceUnavailable'
5787 $ref: '#/components/responses/UnexpectedError'
5789 $ref: '#/components/responses/UnexpectedError'
5795 summary: Query information about multiple VCAs
5796 description: Query information about multiple VCAs
5797 operationId: getVcas
5804 $ref: '#/components/schemas/ArrayOfVcaInfo'
5807 $ref: '#/components/schemas/ArrayOfVcaInfo'
5809 $ref: '#/components/responses/BadRequest'
5811 $ref: '#/components/responses/Unauthorized'
5813 $ref: '#/components/responses/Forbidden'
5815 $ref: '#/components/responses/NotFound'
5817 $ref: '#/components/responses/MethodNotAllowed'
5819 $ref: '#/components/responses/NotAcceptable'
5821 $ref: '#/components/responses/Conflict'
5823 $ref: '#/components/responses/UnprocessableEntity'
5825 $ref: '#/components/responses/InternalServerError'
5827 $ref: '#/components/responses/ServiceUnavailable'
5829 $ref: '#/components/responses/UnexpectedError'
5831 $ref: '#/components/responses/UnexpectedError'
5836 summary: Create a new VCA
5837 description: Create a new VCA
5838 operationId: createVca
5840 $ref: '#/components/requestBodies/CreateVcaRequest'
5843 description: Accepted
5847 $ref: '#/components/schemas/ObjectId_plus_OpId'
5850 $ref: '#/components/schemas/ObjectId_plus_OpId'
5852 $ref: '#/components/responses/BadRequest'
5854 $ref: '#/components/responses/Unauthorized'
5856 $ref: '#/components/responses/Forbidden'
5858 $ref: '#/components/responses/NotFound'
5860 $ref: '#/components/responses/MethodNotAllowed'
5862 $ref: '#/components/responses/NotAcceptable'
5864 $ref: '#/components/responses/Conflict'
5866 $ref: '#/components/responses/UnprocessableEntity'
5868 $ref: '#/components/responses/InternalServerError'
5870 $ref: '#/components/responses/ServiceUnavailable'
5872 $ref: '#/components/responses/UnexpectedError'
5874 $ref: '#/components/responses/UnexpectedError'
5875 '/admin/v1/vca/{vcaId}':
5888 summary: Query information about an individual VCA
5889 description: Query information about an individual VCA
5897 $ref: '#/components/schemas/VcaInfo'
5900 $ref: '#/components/schemas/VcaInfo'
5902 $ref: '#/components/responses/BadRequest'
5904 $ref: '#/components/responses/Unauthorized'
5906 $ref: '#/components/responses/Forbidden'
5908 $ref: '#/components/responses/NotFound'
5910 $ref: '#/components/responses/MethodNotAllowed'
5912 $ref: '#/components/responses/NotAcceptable'
5914 $ref: '#/components/responses/Conflict'
5916 $ref: '#/components/responses/UnprocessableEntity'
5918 $ref: '#/components/responses/InternalServerError'
5920 $ref: '#/components/responses/ServiceUnavailable'
5922 $ref: '#/components/responses/UnexpectedError'
5924 $ref: '#/components/responses/UnexpectedError'
5929 summary: Modify a VCA
5930 description: Modify a VCA
5931 operationId: editVca
5933 $ref: '#/components/requestBodies/EditVcaRequest'
5936 description: Accepted
5940 $ref: '#/components/schemas/OpId'
5943 $ref: '#/components/schemas/OpId'
5945 $ref: '#/components/responses/BadRequest'
5947 $ref: '#/components/responses/Unauthorized'
5949 $ref: '#/components/responses/Forbidden'
5951 $ref: '#/components/responses/NotFound'
5953 $ref: '#/components/responses/MethodNotAllowed'
5955 $ref: '#/components/responses/NotAcceptable'
5957 $ref: '#/components/responses/Conflict'
5959 $ref: '#/components/responses/UnprocessableEntity'
5961 $ref: '#/components/responses/InternalServerError'
5963 $ref: '#/components/responses/ServiceUnavailable'
5965 $ref: '#/components/responses/UnexpectedError'
5967 $ref: '#/components/responses/UnexpectedError'
5972 summary: Delete a VCA
5973 description: Delete a VCA
5974 operationId: deleteVca
5977 description: Accepted
5979 $ref: '#/components/responses/BadRequest'
5981 $ref: '#/components/responses/Unauthorized'
5983 $ref: '#/components/responses/Forbidden'
5985 $ref: '#/components/responses/NotFound'
5987 $ref: '#/components/responses/MethodNotAllowed'
5989 $ref: '#/components/responses/NotAcceptable'
5991 $ref: '#/components/responses/Conflict'
5993 $ref: '#/components/responses/UnprocessableEntity'
5995 $ref: '#/components/responses/InternalServerError'
5997 $ref: '#/components/responses/ServiceUnavailable'
5999 $ref: '#/components/responses/UnexpectedError'
6001 $ref: '#/components/responses/UnexpectedError'
6002 '/admin/v1/k8srepos':
6007 summary: Query information about multiple K8s Repos
6008 description: Query information about multiple K8s Repos
6009 operationId: getK8sRepos
6016 $ref: '#/components/schemas/ArrayOfK8sRepoInfo'
6019 $ref: '#/components/schemas/ArrayOfK8sRepoInfo'
6021 $ref: '#/components/responses/BadRequest'
6023 $ref: '#/components/responses/Unauthorized'
6025 $ref: '#/components/responses/Forbidden'
6027 $ref: '#/components/responses/NotFound'
6029 $ref: '#/components/responses/MethodNotAllowed'
6031 $ref: '#/components/responses/NotAcceptable'
6033 $ref: '#/components/responses/Conflict'
6035 $ref: '#/components/responses/UnprocessableEntity'
6037 $ref: '#/components/responses/InternalServerError'
6039 $ref: '#/components/responses/ServiceUnavailable'
6041 $ref: '#/components/responses/UnexpectedError'
6043 $ref: '#/components/responses/UnexpectedError'
6048 summary: Create a new K8s Repo
6049 description: Create a new K8s Repo
6050 operationId: createK8sRepo
6052 $ref: '#/components/requestBodies/CreateK8sRepoRequest'
6055 description: Accepted
6059 $ref: '#/components/schemas/ObjectId_plus_OpId'
6062 $ref: '#/components/schemas/ObjectId_plus_OpId'
6064 $ref: '#/components/responses/BadRequest'
6066 $ref: '#/components/responses/Unauthorized'
6068 $ref: '#/components/responses/Forbidden'
6070 $ref: '#/components/responses/NotFound'
6072 $ref: '#/components/responses/MethodNotAllowed'
6074 $ref: '#/components/responses/NotAcceptable'
6076 $ref: '#/components/responses/Conflict'
6078 $ref: '#/components/responses/UnprocessableEntity'
6080 $ref: '#/components/responses/InternalServerError'
6082 $ref: '#/components/responses/ServiceUnavailable'
6084 $ref: '#/components/responses/UnexpectedError'
6086 $ref: '#/components/responses/UnexpectedError'
6087 '/admin/v1/k8srepos/{k8sRepoId}':
6092 description: K8s Repo ID
6100 summary: Query information about an individual K8s Repo
6101 description: Query information about an individual K8s Repo
6102 operationId: getK8sRepo
6109 $ref: '#/components/schemas/K8sRepoInfo'
6112 $ref: '#/components/schemas/K8sRepoInfo'
6114 $ref: '#/components/responses/BadRequest'
6116 $ref: '#/components/responses/Unauthorized'
6118 $ref: '#/components/responses/Forbidden'
6120 $ref: '#/components/responses/NotFound'
6122 $ref: '#/components/responses/MethodNotAllowed'
6124 $ref: '#/components/responses/NotAcceptable'
6126 $ref: '#/components/responses/Conflict'
6128 $ref: '#/components/responses/UnprocessableEntity'
6130 $ref: '#/components/responses/InternalServerError'
6132 $ref: '#/components/responses/ServiceUnavailable'
6134 $ref: '#/components/responses/UnexpectedError'
6136 $ref: '#/components/responses/UnexpectedError'
6141 summary: Delete a K8s Repo
6142 description: Delete a K8s Repo
6143 operationId: deleteK8sRepo
6146 description: Accepted
6148 $ref: '#/components/responses/BadRequest'
6150 $ref: '#/components/responses/Unauthorized'
6152 $ref: '#/components/responses/Forbidden'
6154 $ref: '#/components/responses/NotFound'
6156 $ref: '#/components/responses/MethodNotAllowed'
6158 $ref: '#/components/responses/NotAcceptable'
6160 $ref: '#/components/responses/Conflict'
6162 $ref: '#/components/responses/UnprocessableEntity'
6164 $ref: '#/components/responses/InternalServerError'
6166 $ref: '#/components/responses/ServiceUnavailable'
6168 $ref: '#/components/responses/UnexpectedError'
6170 $ref: '#/components/responses/UnexpectedError'
6174 description: Find out more about OSM
6175 url: 'https://osm.etsi.org/docs/user-guide/'
6180 description: Bad request. The server cannot process the request due to a client error.
6184 $ref: '#/components/schemas/ProblemDetails'
6186 description: Authorization information is missing or invalid.
6190 $ref: '#/components/schemas/ProblemDetails'
6192 description: Not enough permissions to do this operation.
6196 $ref: '#/components/schemas/ProblemDetails'
6198 description: The specified resource was not found.
6202 $ref: '#/components/schemas/ProblemDetails'
6204 description: This method is not supported for the requested resource.
6208 $ref: '#/components/schemas/ProblemDetails'
6210 description: The requested resource content cannot match the Accept headers sent in the request.
6214 $ref: '#/components/schemas/ProblemDetails'
6216 description: The operation cannot be executed currently, due to a conflict with the state of the resource.
6220 $ref: '#/components/schemas/ProblemDetails'
6221 UnprocessableEntity:
6222 description: The request was well-formed but was unable to be followed due to semantic errors.
6226 $ref: '#/components/schemas/ProblemDetails'
6227 InternalServerError:
6228 description: Internal server error.
6232 $ref: '#/components/schemas/ProblemDetails'
6234 description: Service temporarily unavailable.
6238 $ref: '#/components/schemas/ProblemDetails'
6240 description: Unexpected error.
6244 $ref: '#/components/schemas/ProblemDetails'
6246 description: VNF Descriptor (plaintext)
6250 $ref: '#/components/schemas/VnfDescriptor'
6252 description: VNF Package (compressed)
6256 $ref: '#/components/schemas/VnfPackage'
6258 description: NS Descriptor (plaintext)
6262 $ref: '#/components/schemas/NsDescriptor'
6264 description: NS Package (compressed)
6268 $ref: '#/components/schemas/NsPackage'
6270 description: NetSlice Template (plaintext)
6274 $ref: '#/components/schemas/NetSliceTemplate'
6276 description: NetSlice Package (compressed)
6280 $ref: '#/components/schemas/NetSlicePackage'
6281 NslcmSubscriptionResponse:
6282 description: NslcmSubscriptionResponse
6286 $ref: '#/components/schemas/NslcmSubscriptionResponse'
6289 $ref: '#/components/schemas/NslcmSubscriptionResponse'
6300 # A free list of key:value pairs
6302 additionalProperties: true
6309 CreateNsdInfoRequest:
6310 # A free list of key:value pairs
6312 additionalProperties: true
6313 NsdInfoModifications:
6315 NS Descriptor Information
6316 Only generic fields (id, name, description) are described
6317 For a full specification of the NS Descriptor see:
6318 http://osm-download.etsi.org/ftp/osm-doc/nsd.html
6322 description: NSD Identifier
6325 description: NSD Name
6328 description: NSD Description
6330 AlarmInfoModifications:
6339 description: To enable/disable the alarm.
6342 description: Threshold value of the Alarm
6346 NS Descriptor Information
6347 Only generic fields (_id, id, name, description) are described
6348 For a full specification of the NS Descriptor see:
6349 http://osm-download.etsi.org/ftp/osm-doc/nsd.html
6354 Identifier of the onboarded individual NS descriptor
6355 resource. This identifier is allocated by the NFVO.
6360 This identifier, which is allocated by the NSD
6361 designer, identifies the NSD in a globally unique
6362 way. It is copied from the NSD content and shall be
6363 present after the NSD content is on-boarded.
6367 Name of the onboarded NSD. This information is
6368 copied from the NSD content and shall be present
6369 after the NSD content is on-boarded.
6373 Description of the onboarded NSD.
6374 This information is copied from the NSD content.
6382 $ref: '#/components/schemas/NsdInfo'
6398 additionalProperties: true
6408 CreateVnfPkgInfoRequest:
6409 # A free list of key:value pairs
6411 additionalProperties: true
6412 VnfPkgInfoModifications:
6414 VNF Package Information
6415 Only generic fields (id, name, description) are described
6416 For a full specification of the VNF Descriptor see:
6417 http://osm-download.etsi.org/ftp/osm-doc/vnfd.html
6421 description: VNF Package Identifier
6424 description: VNF Package Name
6427 description: VNF Package description
6431 VNF Package Information
6432 Only generic fields (_id, id, name, description) are described
6433 For a full specification of the VNF Descriptor see:
6434 http://osm-download.etsi.org/ftp/osm-doc/vnfd.html
6439 Identifier of the VNF package. This identifier is allocated by the NFVO.
6443 description: VNF Package Identifier
6446 description: VNF Package Name
6449 description: VNF Package description
6457 $ref: '#/components/schemas/VnfPkgInfo'
6459 # Substituted by InstantiateNsRequest
6462 NS Instance Information
6463 Only generic fields (_id, id, name, description) are described
6464 For a full specification of the NS Instance see:
6465 http://osm-download.etsi.org/ftp/osm-doc/nsr.html
6469 description: Identifier of the NS instance.
6473 description: Identifier of the NS instance.
6477 description: Human readable name of the NS instance.
6480 description: Human readable description of the NS instance.
6486 InstantiateNsRequest:
6491 Human-readable name of the NS instance to be created.
6495 Identifier of the NSD that defines the NS instance to be created.
6500 Identifier of the VIM Account where the NS instance shall be created.
6519 additionalParamsForNs:
6521 additionalProperties: true
6522 additionalParamsForVnf: &additionalparamsforvnf
6531 additionalProperties: true
6535 use this namespace for all the KDU deployed in this VNF
6536 (if any). By default it is used the id of the project
6537 additionalParamsForVdu:
6546 additionalProperties: true
6550 additionalProperties: false
6551 additionalParamsForKdu:
6560 description: use this namespace for this KDU
6565 additionalProperties: true
6569 additionalProperties: false
6573 additionalProperties: false
6586 To compute automatically the target VIM for each VNF based on
6587 constrains, e.g. latency. Currently only 'PLA' is supported
6588 placement-constraints:
6590 additionalProperties: true
6624 additionalProperties: false
6639 floating-ip-required:
6643 additionalProperties: false
6647 additionalProperties: false
6686 additionalProperties: false
6700 additionalProperties: false
6702 additionalProperties: false
6714 connect additional ports to the created underlay SDN connectivity.
6715 Normally for external connectivy.
6729 additionalProperties: true
6734 additionalProperties: false
6735 internal-connection-point:
6748 additionalProperties: False
6753 additionalProperties: false
6758 additionalProperties: false
6777 additionalProperties: true
6785 additionalProperties: true
6793 additionalProperties: false
6794 vnfd-connection-point-ref:
6799 member-vnf-index-ref:
6801 vnfd-connection-point-ref:
6807 - member-vnf-index-ref
6808 - vnfd-connection-point-ref
6810 additionalProperties: false
6814 additionalProperties: false
6820 additionalProperties: false
6829 description: timeout for the scale operation
6842 scaling-group-descriptor:
6849 - scaling-group-descriptor
6851 additionalProperties: false
6855 additionalProperties: false
6859 additionalProperties: false
6863 timeout_ns_terminate:
6864 description: timeout for terminate operation
6867 description: remove network service if termination end without error
6869 skip_terminate_primitives:
6870 description: Do not execute network service termination primitives
6872 additionalProperties: false
6876 $ref: '#/components/schemas/NsInstance'
6877 NSinstanceActionRequest:
6883 name of the primitive in the 'config-descriptor'. If the target is
6884 a kdu it can be also 'status', 'rollback' or 'upgrade'
6886 description: parameters of this primitive
6887 $ref: '#/components/schemas/KeyValuePairs'
6890 description: provide if the target action is for a vnf, vdu or kdu
6893 description: provide if the target action is for a vdu
6896 description: provide if the target action is for a kdu
6900 description: timeout for the day 1/2 operation
6905 additionalProperties: false
6906 # CreateNSinstanceContentRequest:
6907 # Substituted by InstantiateNsRequest
6908 CreateNSinstanceContentResponse:
6931 isAutomaticInvocation:
6973 $ref: '#/components/schemas/NsLcmOpOcc'
6976 VNF Instance Information
6977 Only generic fields (_id, id) are described
6978 For a full specification of the VNF Instance see:
6979 http://osm-download.etsi.org/ftp/osm-doc/vnfr.html
6988 ArrayOfVnfInstanceInfo:
6991 $ref: '#/components/schemas/VnfInstanceInfo'
6994 NetSlice Template Information
6995 Only generic fields (_id, id, name) are described
6996 For a full specification of the NetSlice Template see:
6997 http://osm-download.etsi.org/ftp/osm-doc/nst.html
7001 description: NetSlice Template Identifier
7005 description: Human readable NetSlice Template Identifier
7008 description: Human readable name of the NetSlice Template
7013 $ref: '#/components/schemas/NstInfo'
7014 CreateNstInfoRequest:
7015 # A free list of key:value pairs
7017 additionalProperties: true
7024 NstInfoModifications:
7026 NetSlice Template Information
7027 Only generic fields (id, name) are described
7028 For a full specification of the NetSlice Template see:
7029 http://osm-download.etsi.org/ftp/osm-doc/nst.html
7033 description: NST Identifier
7036 description: NST Name
7040 NetSlice Instance Information
7041 Only generic fields (_id, id, name, description) are described
7042 For a full specification of the NetSlice Instance see:
7043 http://osm-download.etsi.org/ftp/osm-doc/nsi.html
7047 description: Identifier of the NetSlice instance.
7051 description: Identifier of the NetSlice instance.
7055 description: Human readable name of the NetSlice instance.
7058 description: Human readable description of the NetSlice instance.
7064 ArrayOfNetSliceInstance:
7067 $ref: '#/components/schemas/NetSliceInstance'
7074 description: Identifier of the Alarm.
7078 description: Identifier of the Alarm.
7082 description: Alarm metric.
7085 description: Threshold value of the Alarm.
7089 description: Operation to be applied.
7092 description: Action to be taken.
7095 description: Current status of the alarm.
7106 $ref: '#/components/schemas/Alarm'
7108 # Substituted by InstantiateNsiRequest
7109 InstantiateNsiRequest:
7114 Human-readable name of the NetSlice instance to be created.
7118 Identifier of the NST that defines the NetSlice instance to be created.
7123 Identifier of the VIM Account where the NetSlice instance shall be created.
7139 additionalParamsForNsi:
7141 additionalProperties: true
7173 additionalParamsForNs:
7175 additionalProperties: true
7176 additionalParamsForVnf: *additionalparamsforvnf
7215 additionalProperties: false
7230 floating-ip-required:
7234 additionalProperties: false
7238 additionalProperties: false
7277 additionalProperties: false
7291 additionalProperties: false
7293 additionalProperties: false
7301 additionalProperties: false
7302 internal-connection-point:
7315 additionalProperties: False
7320 additionalProperties: false
7325 additionalProperties: false
7344 additionalProperties: true
7352 additionalProperties: true
7360 additionalProperties: false
7361 vnfd-connection-point-ref:
7366 member-vnf-index-ref:
7368 vnfd-connection-point-ref:
7374 - member-vnf-index-ref
7375 - vnfd-connection-point-ref
7377 additionalProperties: false
7381 additionalProperties: false
7383 additionalProperties: false
7402 additionalProperties: true
7405 additionalProperties: false
7411 additionalProperties: false
7412 TerminateNsiRequest:
7417 Timestamp indicating the end time of the NSI, i.e. the NSI will be terminated
7418 automatically at this timestamp. Cardinality "0" indicates the NSI termination
7419 takes place immediately.
7428 $ref: '#/components/schemas/KeyValuePairs'
7437 # CreateNsiContentRequest:
7438 # Substituted by InstantiateNsiRequest
7439 CreateNsiContentResponse:
7462 isAutomaticInvocation:
7509 $ref: '#/components/schemas/NsiLcmOpOcc'
7553 $ref: '#/components/schemas/TokenInfo'
7576 project_role_mappings:
7598 $ref: '#/components/schemas/UserInfo'
7599 ProjectRoleMappings:
7611 additionalProperties: false
7612 ProjectRoleMappingsOpt:
7623 additionalProperties: false
7635 project_role_mappings:
7636 $ref: '#/components/schemas/ProjectRoleMappings'
7640 additionalProperties: false
7647 additionalProperties: true
7650 Array edition keys must start with '$'
7651 and follow the syntax defined in: https://osm.etsi.org/wikipub/index.php/NBI_API_Description
7661 - $ref: '#/components/schemas/ShortNameList'
7662 - $ref: '#/components/schemas/ArrayEditionSchema'
7663 project_role_mappings:
7664 $ref: '#/components/schemas/ProjectRoleMappings'
7665 add_project_role_mappings:
7666 $ref: '#/components/schemas/ProjectRoleMappings'
7667 remove_project_role_mappings:
7668 $ref: '#/components/schemas/ProjectRoleMappingsOpt'
7724 additionalProperties: false
7780 additionalProperties: false
7790 $ref: '#/components/schemas/QuotasInfo'
7794 $ref: '#/components/schemas/ProjectInfo'
7795 CreateProjectRequest:
7803 $ref: '#/components/schemas/QuotasInfo'
7806 additionalProperties: false
7815 $ref: '#/components/schemas/EditQuotasInfo'
7816 additionalProperties: false
7819 additionalProperties:
7823 Permissions keys must follow the syntax 'main_topic[:subtopic[:id[:component|action|etc]]]'
7824 Permission values are either true or false
7825 EditPermissionsInfo:
7827 additionalProperties:
7831 Permissions keys must follow the syntax 'main_topic[:subtopic[:id[:component|action|etc]]]'
7832 Permission values are either true, false, or null
7842 $ref: '#/components/schemas/PermissionsInfo'
7846 $ref: '#/components/schemas/RoleInfo'
7853 $ref: '#/components/schemas/PermissionsInfo'
7856 additionalProperties: false
7863 $ref: '#/components/schemas/EditPermissionsInfo'
7864 additionalProperties: false
7895 $ref: '#/components/schemas/VimType'
7910 additionalProperties: true
7916 $ref: '#/components/schemas/VimInfo'
7934 $ref: '#/components/schemas/VimType'
7949 additionalProperties: true
7959 additionalProperties: false
7972 $ref: '#/components/schemas/VimType'
7987 additionalProperties: true
7988 additionalProperties: false
8030 $ref: '#/components/schemas/WimType'
8040 additionalProperties: true
8044 $ref: '#/components/schemas/WimInfo'
8060 $ref: '#/components/schemas/WimType'
8070 additionalProperties: true
8075 additionalProperties: false
8096 additionalProperties: true
8097 additionalProperties: false
8136 - $ref: '#/components/schemas/SdnExtraProperties'
8137 - $ref: '#/components/schemas/SdnBasicProperties'
8141 $ref: '#/components/schemas/SdnInfo'
8144 - $ref: '#/components/schemas/SdnBasicProperties'
8151 additionalProperties: false
8154 - $ref: '#/components/schemas/SdnBasicProperties'
8155 additionalProperties: false
8211 additionalProperties: false
8235 $ref: '#/components/schemas/PduInterfaces'
8239 $ref: '#/components/schemas/PduInfo'
8260 $ref: '#/components/schemas/PduInterfaces'
8265 additionalProperties: false
8286 $ref: '#/components/schemas/PduInterfaces'
8287 additionalProperties: false
8292 additionalProperties: true
8310 additionalProperties: true
8317 $ref: '#/components/schemas/K8sClusterNetList'
8324 ArrayOfK8sClusterInfo:
8327 $ref: '#/components/schemas/K8sClusterInfo'
8328 CreateK8sClusterRequest:
8342 additionalProperties: true
8349 $ref: '#/components/schemas/K8sClusterNetList'
8362 additionalProperties: false
8363 EditK8sClusterRequest:
8372 additionalProperties: true
8379 $ref: '#/components/schemas/K8sClusterNetList'
8386 additionalProperties: false
8420 additionalProperties: true
8424 $ref: '#/components/schemas/VcaInfo'
8455 additionalProperties: true
8466 additionalProperties: false
8492 additionalProperties: true
8493 additionalProperties: false
8510 $ref: '#/components/schemas/K8sRepoType'
8516 description: repository username
8519 description: repository password
8522 description: verify certificates of HTTPS-enabled servers using this CA bundle
8525 description: identify HTTPS client using this SSL certificate file
8528 description: skip tls certificate checks for the repository
8531 description: identify HTTPS client using this SSL key file
8535 $ref: '#/components/schemas/K8sRepoInfo'
8536 CreateK8sRepoRequest:
8544 $ref: '#/components/schemas/K8sRepoType'
8552 additionalProperties: false
8553 NslcmSubscriptionResponse:
8566 NslcmSubscriptionInfo:
8583 $ref: '#/components/schemas/Authenticationschema'
8584 ArrayOfNslcmSubscriptionInfo:
8587 $ref: '#/components/schemas/NslcmSubscriptionInfo'
8588 NsInstanceSubscriptionFilter:
8590 used to identify the network service
8593 - $ref: '#/components/schemas/nsdIds'
8594 - $ref: '#/components/schemas/vnfdIds'
8595 - $ref: '#/components/schemas/pnfdIds'
8596 - $ref: '#/components/schemas/nsInstanceIds'
8597 - $ref: '#/components/schemas/nsInstanceNames'
8621 nsInstanceSubscriptionFilter:
8622 $ref: '#/components/schemas/NsInstanceSubscriptionFilter'
8625 If NsLcmOperationOccurrenceNotification is selected then at least operationTypes or states is required. If NsLcmOperationOccurrenceNotification is selected then at least nsComponentTypes, lcmOpName and lcmOpOccStatus is required
8630 - NsIdentifierCreationNotification
8631 - NsIdentifierDeletionNotification
8632 - NsLcmOperationOccurrenceNotification
8633 - NsChangeNotification
8651 - PARTIALLY_COMPLETED
8664 lcmOpNameImpactingNsComponent:
8671 - VNF_SCALE_TO_LEVEL
8672 - VNF_CHANGE_FLAVOUR
8676 - VNF_CHANGE_EXT_CONN
8683 lcmOpOccStatusImpactingNsComponent:
8690 - PARTIALLY_COMPLETED
8693 Authenticationschema:
8707 NslcmSubscriptionRequest:
8711 $ref: '#/components/schemas/Nslcmsubschema'
8716 $ref: '#/components/schemas/Authenticationschema'
8722 CreateNsdInfoRequest:
8726 $ref: '#/components/schemas/CreateNsdInfoRequest'
8729 $ref: '#/components/schemas/CreateNsdInfoRequest'
8730 NsdInfoModifications:
8734 $ref: '#/components/schemas/NsdInfoModifications'
8737 $ref: '#/components/schemas/NsdInfoModifications'
8738 AlarmInfoModifications:
8742 $ref: '#/components/schemas/AlarmInfoModifications'
8745 $ref: '#/components/schemas/AlarmInfoModifications'
8750 $ref: '#/components/schemas/NsDescriptor'
8755 $ref: '#/components/schemas/NsPackage'
8756 CreateVnfPkgInfoRequest:
8760 $ref: '#/components/schemas/CreateVnfPkgInfoRequest'
8763 $ref: '#/components/schemas/CreateVnfPkgInfoRequest'
8764 VnfPkgInfoModifications:
8768 $ref: '#/components/schemas/VnfPkgInfoModifications'
8771 $ref: '#/components/schemas/VnfPkgInfoModifications'
8776 $ref: '#/components/schemas/VnfPackage'
8781 $ref: '#/components/schemas/VnfDescriptor'
8783 # Substituted by InstantiateNsRequest
8784 InstantiateNsRequest:
8788 $ref: '#/components/schemas/InstantiateNsRequest'
8791 $ref: '#/components/schemas/InstantiateNsRequest'
8796 $ref: '#/components/schemas/ScaleNsRequest'
8799 $ref: '#/components/schemas/ScaleNsRequest'
8804 $ref: '#/components/schemas/TerminateNsRequest'
8807 $ref: '#/components/schemas/TerminateNsRequest'
8808 # CreateNSinstanceContentRequest:
8809 # Substituted by InstantiateNsRequest
8810 CreateNstInfoRequest:
8814 $ref: '#/components/schemas/CreateNstInfoRequest'
8817 $ref: '#/components/schemas/CreateNstInfoRequest'
8822 $ref: '#/components/schemas/NetSliceTemplate'
8827 $ref: '#/components/schemas/NetSlicePackage'
8828 NstInfoModifications:
8832 $ref: '#/components/schemas/NstInfoModifications'
8835 $ref: '#/components/schemas/NstInfoModifications'
8837 # Substituted by InstantiateNsiRequest
8838 InstantiateNsiRequest:
8842 $ref: '#/components/schemas/InstantiateNsiRequest'
8845 $ref: '#/components/schemas/InstantiateNsiRequest'
8846 TerminateNsiRequest:
8850 $ref: '#/components/schemas/TerminateNsiRequest'
8853 $ref: '#/components/schemas/TerminateNsiRequest'
8858 $ref: '#/components/schemas/NsiActionRequest'
8861 $ref: '#/components/schemas/NsiActionRequest'
8862 # CreateNsiContentRequest:
8863 # Substituted by InstantiateNsiRequest
8868 $ref: '#/components/schemas/CreateTokenRequest'
8871 $ref: '#/components/schemas/CreateTokenRequest'
8876 $ref: '#/components/schemas/CreateUserRequest'
8879 $ref: '#/components/schemas/CreateUserRequest'
8884 $ref: '#/components/schemas/EditUserRequest'
8887 $ref: '#/components/schemas/EditUserRequest'
8888 CreateProjectRequest:
8892 $ref: '#/components/schemas/CreateProjectRequest'
8895 $ref: '#/components/schemas/CreateProjectRequest'
8900 $ref: '#/components/schemas/EditProjectRequest'
8903 $ref: '#/components/schemas/EditProjectRequest'
8908 $ref: '#/components/schemas/CreateRoleRequest'
8911 $ref: '#/components/schemas/CreateRoleRequest'
8916 $ref: '#/components/schemas/EditRoleRequest'
8919 $ref: '#/components/schemas/EditRoleRequest'
8924 $ref: '#/components/schemas/CreateVimRequest'
8927 $ref: '#/components/schemas/CreateVimRequest'
8932 $ref: '#/components/schemas/EditVimRequest'
8935 $ref: '#/components/schemas/EditVimRequest'
8940 $ref: '#/components/schemas/CreateWimRequest'
8943 $ref: '#/components/schemas/CreateWimRequest'
8948 $ref: '#/components/schemas/EditWimRequest'
8951 $ref: '#/components/schemas/EditWimRequest'
8956 $ref: '#/components/schemas/CreateSdnRequest'
8959 $ref: '#/components/schemas/CreateSdnRequest'
8964 $ref: '#/components/schemas/EditSdnRequest'
8967 $ref: '#/components/schemas/EditSdnRequest'
8972 $ref: '#/components/schemas/CreatePduRequest'
8975 $ref: '#/components/schemas/CreatePduRequest'
8980 $ref: '#/components/schemas/EditPduRequest'
8983 $ref: '#/components/schemas/EditPduRequest'
8984 CreateK8sClusterRequest:
8988 $ref: '#/components/schemas/CreateK8sClusterRequest'
8991 $ref: '#/components/schemas/CreateK8sClusterRequest'
8992 EditK8sClusterRequest:
8996 $ref: '#/components/schemas/EditK8sClusterRequest'
8999 $ref: '#/components/schemas/EditK8sClusterRequest'
9004 $ref: '#/components/schemas/CreateVcaRequest'
9007 $ref: '#/components/schemas/CreateVcaRequest'
9012 $ref: '#/components/schemas/EditVcaRequest'
9015 $ref: '#/components/schemas/EditVcaRequest'
9016 CreateK8sRepoRequest:
9020 $ref: '#/components/schemas/CreateK8sRepoRequest'
9023 $ref: '#/components/schemas/CreateK8sRepoRequest'
9024 NslcmSubscriptionRequest:
9028 $ref: '#/components/schemas/NslcmSubscriptionRequest'
9031 $ref: '#/components/schemas/NslcmSubscriptionRequest'
9032 # END REQUEST BODIES