4 - description: OSM NB API
5 url: 'https://osm.etsi.org/nbapi/v1.0.0'
9 This is Open Source MANO Northbound API featuring ETSI NFV SOL005.
10 For more information on OSM, you can visit [http://osm.etsi.org](http://osm.etsi.org).
11 You can send us your comments and questions to OSM_TECH@list.etsi.org
12 or join the [OpenSourceMANO Slack Workplace](https://join.slack.com/t/opensourcemano/shared_invite/enQtMzQ3MzYzNTQ0NDIyLWVkNTE4ZjZjNWI0ZTQyN2VhOTI1MjViMzU1NWYwMWM3ODI4NTQyY2VlODA2ZjczMWIyYTFkZWNiZmFkM2M2ZDk)
14 title: OSM NB API featuring ETSI NFV SOL005
16 email: OSM_TECH@list.etsi.org
19 url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
22 - name: 'VNF packages'
23 description: Management operations of VNF descriptors and packages
25 description: Management operations of NS descriptors and packages
26 - name: 'NS instances'
27 description: Management operations of NS instances
28 - name: 'NetSlice templates'
29 description: Management operations of NetSlice Templates
30 - name: 'NetSlice instances'
31 description: Management operations of NetSlice Instances
32 - name: 'NS Performance Management'
33 description: Management operations related to Performance Mangement of NS instances
34 - name: 'Physical Data Units (PDU)'
35 description: Management operations of PDUs
36 - name: 'Authentication'
37 description: Authentication operations
39 description: Management operations of users, projects and roles
40 - name: 'Infrastructure'
41 description: Management operations of VIM, VIM accounts, WIM and SDN controllers
42 - name: 'Repositories'
43 description: Management operations of repositories
45 description: Management operations of Administration items
53 '/nsd/v1/ns_descriptors':
57 summary: Query information about multiple NS descriptor resources
58 description: Query information about multiple NS descriptor resources
66 $ref: '#/components/schemas/ArrayOfNsdInfo'
69 $ref: '#/components/schemas/ArrayOfNsdInfo'
71 $ref: '#/components/responses/BadRequest'
73 $ref: '#/components/responses/Unauthorized'
75 $ref: '#/components/responses/Forbidden'
77 $ref: '#/components/responses/NotFound'
79 $ref: '#/components/responses/MethodNotAllowed'
81 $ref: '#/components/responses/NotAcceptable'
83 $ref: '#/components/responses/Conflict'
85 $ref: '#/components/responses/UnprocessableEntity'
87 $ref: '#/components/responses/InternalServerError'
89 $ref: '#/components/responses/ServiceUnavailable'
91 $ref: '#/components/responses/UnexpectedError'
93 $ref: '#/components/responses/UnexpectedError'
97 summary: Create a new NS descriptor resource
98 description: Create a new NS descriptor resource
101 $ref: '#/components/requestBodies/CreateNsdInfoRequest'
113 $ref: '#/components/schemas/ObjectId'
116 $ref: '#/components/schemas/ObjectId'
118 $ref: '#/components/responses/BadRequest'
120 $ref: '#/components/responses/Unauthorized'
122 $ref: '#/components/responses/Forbidden'
124 $ref: '#/components/responses/NotFound'
126 $ref: '#/components/responses/MethodNotAllowed'
128 $ref: '#/components/responses/NotAcceptable'
130 $ref: '#/components/responses/Conflict'
132 $ref: '#/components/responses/UnprocessableEntity'
134 $ref: '#/components/responses/InternalServerError'
136 $ref: '#/components/responses/ServiceUnavailable'
138 $ref: '#/components/responses/UnexpectedError'
140 $ref: '#/components/responses/UnexpectedError'
141 '/nsd/v1/ns_descriptors/{nsdInfoId}':
146 description: NSD Info ID
152 summary: Read information about an individual NS descriptor resource
153 description: Read information about an individual NS descriptor resource
161 $ref: '#/components/schemas/NsdInfo'
164 $ref: '#/components/schemas/NsdInfo'
166 $ref: '#/components/responses/BadRequest'
168 $ref: '#/components/responses/Unauthorized'
170 $ref: '#/components/responses/Forbidden'
172 $ref: '#/components/responses/NotFound'
174 $ref: '#/components/responses/MethodNotAllowed'
176 $ref: '#/components/responses/NotAcceptable'
178 $ref: '#/components/responses/Conflict'
180 $ref: '#/components/responses/UnprocessableEntity'
182 $ref: '#/components/responses/InternalServerError'
184 $ref: '#/components/responses/ServiceUnavailable'
186 $ref: '#/components/responses/UnexpectedError'
188 $ref: '#/components/responses/UnexpectedError'
192 summary: Delete an individual NS descriptor resource
193 description: Delete an individual NS descriptor resource
194 operationId: deleteNSD
197 description: No Content
199 $ref: '#/components/responses/BadRequest'
201 $ref: '#/components/responses/Unauthorized'
203 $ref: '#/components/responses/Forbidden'
205 $ref: '#/components/responses/NotFound'
207 $ref: '#/components/responses/MethodNotAllowed'
209 $ref: '#/components/responses/NotAcceptable'
211 $ref: '#/components/responses/Conflict'
213 $ref: '#/components/responses/UnprocessableEntity'
215 $ref: '#/components/responses/InternalServerError'
217 $ref: '#/components/responses/ServiceUnavailable'
219 $ref: '#/components/responses/UnexpectedError'
221 $ref: '#/components/responses/UnexpectedError'
225 summary: Modify the data of an individual NS descriptor resource
226 description: Modify the data of an individual NS descriptor resource
227 operationId: updateNSD
229 $ref: '#/components/requestBodies/NsdInfoModifications'
232 description: No Content
234 $ref: '#/components/responses/BadRequest'
236 $ref: '#/components/responses/Unauthorized'
238 $ref: '#/components/responses/Forbidden'
240 $ref: '#/components/responses/NotFound'
242 $ref: '#/components/responses/MethodNotAllowed'
244 $ref: '#/components/responses/NotAcceptable'
246 $ref: '#/components/responses/Conflict'
248 $ref: '#/components/responses/UnprocessableEntity'
250 $ref: '#/components/responses/InternalServerError'
252 $ref: '#/components/responses/ServiceUnavailable'
254 $ref: '#/components/responses/UnexpectedError'
256 $ref: '#/components/responses/UnexpectedError'
257 '/nsd/v1/ns_descriptors/{nsdInfoId}/nsd_content':
262 description: NSD Info ID
268 summary: Fetch the content of a NSD
269 description: Fetch the content of a NSD
270 operationId: getNSDcontent
277 $ref: '#/components/schemas/NsPackage'
279 description: Partial Content
287 $ref: '#/components/schemas/NsPackage'
289 $ref: '#/components/responses/BadRequest'
291 $ref: '#/components/responses/Unauthorized'
293 $ref: '#/components/responses/Forbidden'
295 $ref: '#/components/responses/NotFound'
297 $ref: '#/components/responses/MethodNotAllowed'
299 $ref: '#/components/responses/NotAcceptable'
301 $ref: '#/components/responses/Conflict'
303 $ref: '#/components/responses/UnprocessableEntity'
305 $ref: '#/components/responses/InternalServerError'
307 $ref: '#/components/responses/ServiceUnavailable'
309 $ref: '#/components/responses/UnexpectedError'
311 $ref: '#/components/responses/UnexpectedError'
315 summary: Upload the content of a NSD
316 description: Upload the content of a NSD
317 operationId: updateNSDcontent
319 $ref: '#/components/requestBodies/NsPackage'
322 description: Accepted
324 description: No Content
326 $ref: '#/components/responses/BadRequest'
328 $ref: '#/components/responses/Unauthorized'
330 $ref: '#/components/responses/Forbidden'
332 $ref: '#/components/responses/NotFound'
334 $ref: '#/components/responses/MethodNotAllowed'
336 $ref: '#/components/responses/NotAcceptable'
338 $ref: '#/components/responses/Conflict'
340 $ref: '#/components/responses/UnprocessableEntity'
342 $ref: '#/components/responses/InternalServerError'
344 $ref: '#/components/responses/ServiceUnavailable'
346 $ref: '#/components/responses/UnexpectedError'
348 $ref: '#/components/responses/UnexpectedError'
349 '/nsd/v1/ns_descriptors/{nsdInfoId}/artifacts/{artifactPath}':
354 description: NS Package ID
360 description: Artifact Path
366 summary: Fetch individual NS package artifact
367 description: Fetch individual NS package artifact
368 operationId: getNsPkgArtifact
373 application/octet-stream:
378 description: Partial Content
384 application/octet-stream:
389 $ref: '#/components/responses/BadRequest'
391 $ref: '#/components/responses/Unauthorized'
393 $ref: '#/components/responses/Forbidden'
395 $ref: '#/components/responses/NotFound'
397 $ref: '#/components/responses/MethodNotAllowed'
399 $ref: '#/components/responses/NotAcceptable'
401 $ref: '#/components/responses/Conflict'
403 $ref: '#/components/responses/UnprocessableEntity'
405 $ref: '#/components/responses/InternalServerError'
407 $ref: '#/components/responses/ServiceUnavailable'
409 $ref: '#/components/responses/UnexpectedError'
411 $ref: '#/components/responses/UnexpectedError'
412 '/nsd/v1/ns_descriptors/{nsdInfoId}/nsd':
417 description: NS Package ID
423 summary: Read NSD of an on-boarded NS package
424 description: Read NSD of an on-boarded NS package
425 operationId: getNsPkgNsd
432 $ref: '#/components/schemas/NsDescriptor'
434 $ref: '#/components/responses/BadRequest'
436 $ref: '#/components/responses/Unauthorized'
438 $ref: '#/components/responses/Forbidden'
440 $ref: '#/components/responses/NotFound'
442 $ref: '#/components/responses/MethodNotAllowed'
444 $ref: '#/components/responses/NotAcceptable'
446 $ref: '#/components/responses/Conflict'
448 $ref: '#/components/responses/UnprocessableEntity'
450 $ref: '#/components/responses/InternalServerError'
452 $ref: '#/components/responses/ServiceUnavailable'
454 $ref: '#/components/responses/UnexpectedError'
456 $ref: '#/components/responses/UnexpectedError'
457 '/nsd/v1/ns_descriptors_content':
461 summary: Upload a NS package by providing the content of the NS package
462 description: Upload a NS package by providing the content of the NS package
463 operationId: uploadNsPkgsContent
468 $ref: '#/components/schemas/NsPackage'
480 $ref: '#/components/schemas/ObjectId'
483 $ref: '#/components/schemas/ObjectId'
485 description: Accepted
487 description: No Content
489 $ref: '#/components/responses/BadRequest'
491 $ref: '#/components/responses/Unauthorized'
493 $ref: '#/components/responses/Forbidden'
495 $ref: '#/components/responses/NotFound'
497 $ref: '#/components/responses/MethodNotAllowed'
499 $ref: '#/components/responses/NotAcceptable'
501 $ref: '#/components/responses/Conflict'
503 $ref: '#/components/responses/UnprocessableEntity'
505 $ref: '#/components/responses/InternalServerError'
507 $ref: '#/components/responses/ServiceUnavailable'
509 $ref: '#/components/responses/UnexpectedError'
511 $ref: '#/components/responses/UnexpectedError'
515 summary: Query information about multiple NS package resources
516 description: Query information about multiple NS package resources
517 operationId: getNsPkgsContent
524 $ref: '#/components/schemas/ArrayOfNsdInfo'
527 $ref: '#/components/schemas/ArrayOfNsdInfo'
529 description: Partial Content
535 application/octet-stream:
540 $ref: '#/components/responses/BadRequest'
542 $ref: '#/components/responses/Unauthorized'
544 $ref: '#/components/responses/Forbidden'
546 $ref: '#/components/responses/NotFound'
548 $ref: '#/components/responses/MethodNotAllowed'
550 $ref: '#/components/responses/NotAcceptable'
552 $ref: '#/components/responses/Conflict'
554 $ref: '#/components/responses/UnprocessableEntity'
556 $ref: '#/components/responses/InternalServerError'
558 $ref: '#/components/responses/ServiceUnavailable'
560 $ref: '#/components/responses/UnexpectedError'
562 $ref: '#/components/responses/UnexpectedError'
563 '/nsd/v1/ns_descriptors_content/{nsdInfoId}':
568 description: NS Package ID
574 summary: Read information about an individual NS package resource
575 description: Read information about an individual NS package resource
576 operationId: getNsPkgsIdContent
583 $ref: '#/components/schemas/NsdInfo'
586 $ref: '#/components/schemas/NsdInfo'
588 $ref: '#/components/responses/BadRequest'
590 $ref: '#/components/responses/Unauthorized'
592 $ref: '#/components/responses/Forbidden'
594 $ref: '#/components/responses/NotFound'
596 $ref: '#/components/responses/MethodNotAllowed'
598 $ref: '#/components/responses/NotAcceptable'
600 $ref: '#/components/responses/Conflict'
602 $ref: '#/components/responses/UnprocessableEntity'
604 $ref: '#/components/responses/InternalServerError'
606 $ref: '#/components/responses/ServiceUnavailable'
608 $ref: '#/components/responses/UnexpectedError'
610 $ref: '#/components/responses/UnexpectedError'
614 summary: Modify an individual NS package resource
615 description: Modify an individual NS package resource
616 operationId: updateNsPkgsIdContent
618 $ref: '#/components/requestBodies/NsdInfoModifications'
621 description: No Content
623 $ref: '#/components/responses/BadRequest'
625 $ref: '#/components/responses/Unauthorized'
627 $ref: '#/components/responses/Forbidden'
629 $ref: '#/components/responses/NotFound'
631 $ref: '#/components/responses/MethodNotAllowed'
633 $ref: '#/components/responses/NotAcceptable'
635 $ref: '#/components/responses/Conflict'
637 $ref: '#/components/responses/UnprocessableEntity'
639 $ref: '#/components/responses/InternalServerError'
641 $ref: '#/components/responses/ServiceUnavailable'
643 $ref: '#/components/responses/UnexpectedError'
645 $ref: '#/components/responses/UnexpectedError'
649 summary: Delete an individual NS package resource
650 description: Delete an individual NS package resource
651 operationId: deleteNSPkgsIdContent
654 description: No Content
656 $ref: '#/components/responses/BadRequest'
658 $ref: '#/components/responses/Unauthorized'
660 $ref: '#/components/responses/Forbidden'
662 $ref: '#/components/responses/NotFound'
664 $ref: '#/components/responses/MethodNotAllowed'
666 $ref: '#/components/responses/NotAcceptable'
668 $ref: '#/components/responses/Conflict'
670 $ref: '#/components/responses/UnprocessableEntity'
672 $ref: '#/components/responses/InternalServerError'
674 $ref: '#/components/responses/ServiceUnavailable'
676 $ref: '#/components/responses/UnexpectedError'
678 $ref: '#/components/responses/UnexpectedError'
682 '/vnfpkgm/v1/vnf_packages':
686 summary: Query information about multiple VNF package resources
687 description: Query information about multiple VNF package resources
688 operationId: getVnfPkgs
695 $ref: '#/components/schemas/ArrayOfVnfPkgInfo'
698 $ref: '#/components/schemas/ArrayOfVnfPkgInfo'
700 $ref: '#/components/responses/BadRequest'
702 $ref: '#/components/responses/Unauthorized'
704 $ref: '#/components/responses/Forbidden'
706 $ref: '#/components/responses/NotFound'
708 $ref: '#/components/responses/MethodNotAllowed'
710 $ref: '#/components/responses/NotAcceptable'
712 $ref: '#/components/responses/Conflict'
714 $ref: '#/components/responses/UnprocessableEntity'
716 $ref: '#/components/responses/InternalServerError'
718 $ref: '#/components/responses/ServiceUnavailable'
720 $ref: '#/components/responses/UnexpectedError'
722 $ref: '#/components/responses/UnexpectedError'
726 summary: Create a new VNF package resource
727 description: Create a new VNF package resource
728 operationId: addVnfPkg
730 $ref: '#/components/requestBodies/CreateVnfPkgInfoRequest'
742 $ref: '#/components/schemas/ObjectId'
745 $ref: '#/components/schemas/ObjectId'
747 $ref: '#/components/responses/BadRequest'
749 $ref: '#/components/responses/Unauthorized'
751 $ref: '#/components/responses/Forbidden'
753 $ref: '#/components/responses/NotFound'
755 $ref: '#/components/responses/MethodNotAllowed'
757 $ref: '#/components/responses/NotAcceptable'
759 $ref: '#/components/responses/Conflict'
761 $ref: '#/components/responses/UnprocessableEntity'
763 $ref: '#/components/responses/InternalServerError'
765 $ref: '#/components/responses/ServiceUnavailable'
767 $ref: '#/components/responses/UnexpectedError'
769 $ref: '#/components/responses/UnexpectedError'
770 '/vnfpkgm/v1/vnf_packages/{vnfPkgId}':
775 description: VNF Package ID
781 summary: Read information about an individual VNF package resource
782 description: Read information about an individual VNF package resource
783 operationId: getVnfPkg
790 $ref: '#/components/schemas/VnfPkgInfo'
793 $ref: '#/components/schemas/VnfPkgInfo'
795 $ref: '#/components/responses/BadRequest'
797 $ref: '#/components/responses/Unauthorized'
799 $ref: '#/components/responses/Forbidden'
801 $ref: '#/components/responses/NotFound'
803 $ref: '#/components/responses/MethodNotAllowed'
805 $ref: '#/components/responses/NotAcceptable'
807 $ref: '#/components/responses/Conflict'
809 $ref: '#/components/responses/UnprocessableEntity'
811 $ref: '#/components/responses/InternalServerError'
813 $ref: '#/components/responses/ServiceUnavailable'
815 $ref: '#/components/responses/UnexpectedError'
817 $ref: '#/components/responses/UnexpectedError'
821 summary: Delete an individual VNF package resource
822 description: Delete an individual VNF package resource
823 operationId: deleteVnfPkg
826 description: No Content
828 $ref: '#/components/responses/BadRequest'
830 $ref: '#/components/responses/Unauthorized'
832 $ref: '#/components/responses/Forbidden'
834 $ref: '#/components/responses/NotFound'
836 $ref: '#/components/responses/MethodNotAllowed'
838 $ref: '#/components/responses/NotAcceptable'
840 $ref: '#/components/responses/Conflict'
842 $ref: '#/components/responses/UnprocessableEntity'
844 $ref: '#/components/responses/InternalServerError'
846 $ref: '#/components/responses/ServiceUnavailable'
848 $ref: '#/components/responses/UnexpectedError'
850 $ref: '#/components/responses/UnexpectedError'
854 summary: Modify an individual VNF package resource
855 description: Modify an individual VNF package resource
856 operationId: updateVnfPkg
858 $ref: '#/components/requestBodies/VnfPkgInfoModifications'
861 description: No Content
863 $ref: '#/components/responses/BadRequest'
865 $ref: '#/components/responses/Unauthorized'
867 $ref: '#/components/responses/Forbidden'
869 $ref: '#/components/responses/NotFound'
871 $ref: '#/components/responses/MethodNotAllowed'
873 $ref: '#/components/responses/NotAcceptable'
875 $ref: '#/components/responses/Conflict'
877 $ref: '#/components/responses/UnprocessableEntity'
879 $ref: '#/components/responses/InternalServerError'
881 $ref: '#/components/responses/ServiceUnavailable'
883 $ref: '#/components/responses/UnexpectedError'
885 $ref: '#/components/responses/UnexpectedError'
886 '/vnfpkgm/v1/vnf_packages/{vnfPkgId}/vnfd':
891 description: VNF Package ID
897 summary: Read VNFD of an on-boarded VNF package
898 description: Read VNFD of an on-boarded VNF package
899 operationId: getVnfPkgVnfd
906 $ref: '#/components/schemas/VnfDescriptor'
908 $ref: '#/components/responses/BadRequest'
910 $ref: '#/components/responses/Unauthorized'
912 $ref: '#/components/responses/Forbidden'
914 $ref: '#/components/responses/NotFound'
916 $ref: '#/components/responses/MethodNotAllowed'
918 $ref: '#/components/responses/NotAcceptable'
920 $ref: '#/components/responses/Conflict'
922 $ref: '#/components/responses/UnprocessableEntity'
924 $ref: '#/components/responses/InternalServerError'
926 $ref: '#/components/responses/ServiceUnavailable'
928 $ref: '#/components/responses/UnexpectedError'
930 $ref: '#/components/responses/UnexpectedError'
931 '/vnfpkgm/v1/vnf_packages/{vnfPkgId}/package_content':
936 description: VNF Package ID
942 summary: Fetch an on-boarded VNF package
943 description: Fetch an on-boarded VNF package
944 operationId: getVnfPkgContent
951 $ref: '#/components/schemas/VnfPackage'
953 description: Partial Content
961 $ref: '#/components/schemas/VnfPackage'
963 $ref: '#/components/responses/BadRequest'
965 $ref: '#/components/responses/Unauthorized'
967 $ref: '#/components/responses/Forbidden'
969 $ref: '#/components/responses/NotFound'
971 $ref: '#/components/responses/MethodNotAllowed'
973 $ref: '#/components/responses/NotAcceptable'
975 $ref: '#/components/responses/Conflict'
977 $ref: '#/components/responses/UnprocessableEntity'
979 $ref: '#/components/responses/InternalServerError'
981 $ref: '#/components/responses/ServiceUnavailable'
983 $ref: '#/components/responses/UnexpectedError'
985 $ref: '#/components/responses/UnexpectedError'
989 summary: Upload a VNF package by providing the content of the VNF package
990 description: Upload a VNF package by providing the content of the VNF package
991 operationId: uploadVnfPkgContent
996 $ref: '#/components/schemas/VnfPackage'
999 description: Accepted
1001 description: No Content
1003 $ref: '#/components/responses/BadRequest'
1005 $ref: '#/components/responses/Unauthorized'
1007 $ref: '#/components/responses/Forbidden'
1009 $ref: '#/components/responses/NotFound'
1011 $ref: '#/components/responses/MethodNotAllowed'
1013 $ref: '#/components/responses/NotAcceptable'
1015 $ref: '#/components/responses/Conflict'
1017 $ref: '#/components/responses/UnprocessableEntity'
1019 $ref: '#/components/responses/InternalServerError'
1021 $ref: '#/components/responses/ServiceUnavailable'
1023 $ref: '#/components/responses/UnexpectedError'
1025 $ref: '#/components/responses/UnexpectedError'
1026 '/vnfpkgm/v1/vnf_packages/{vnfPkgId}/artifacts/{artifactPath}':
1031 description: VNF Package ID
1034 - name: artifactPath
1037 description: Artifact Path
1043 summary: Fetch individual VNF package artifact
1044 description: Fetch individual VNF package artifact
1045 operationId: getVnfPkgArtifact
1050 application/octet-stream:
1055 description: Partial Content
1061 application/octet-stream:
1066 $ref: '#/components/responses/BadRequest'
1068 $ref: '#/components/responses/Unauthorized'
1070 $ref: '#/components/responses/Forbidden'
1072 $ref: '#/components/responses/NotFound'
1074 $ref: '#/components/responses/MethodNotAllowed'
1076 $ref: '#/components/responses/NotAcceptable'
1078 $ref: '#/components/responses/Conflict'
1080 $ref: '#/components/responses/UnprocessableEntity'
1082 $ref: '#/components/responses/InternalServerError'
1084 $ref: '#/components/responses/ServiceUnavailable'
1086 $ref: '#/components/responses/UnexpectedError'
1088 $ref: '#/components/responses/UnexpectedError'
1089 '/vnfpkgm/v1/vnf_packages_content':
1093 summary: Upload a VNF package by providing the content of the VNF package
1094 description: Upload a VNF package by providing the content of the VNF package
1095 operationId: uploadVnfPkgsContent
1100 $ref: '#/components/schemas/VnfPackage'
1103 description: Created
1112 $ref: '#/components/schemas/ObjectId'
1115 $ref: '#/components/schemas/ObjectId'
1117 description: Accepted
1119 description: No Content
1121 $ref: '#/components/responses/BadRequest'
1123 $ref: '#/components/responses/Unauthorized'
1125 $ref: '#/components/responses/Forbidden'
1127 $ref: '#/components/responses/NotFound'
1129 $ref: '#/components/responses/MethodNotAllowed'
1131 $ref: '#/components/responses/NotAcceptable'
1133 $ref: '#/components/responses/Conflict'
1135 $ref: '#/components/responses/UnprocessableEntity'
1137 $ref: '#/components/responses/InternalServerError'
1139 $ref: '#/components/responses/ServiceUnavailable'
1141 $ref: '#/components/responses/UnexpectedError'
1143 $ref: '#/components/responses/UnexpectedError'
1147 summary: Query information about multiple VNF package resources
1148 description: Query information about multiple VNF package resources
1149 operationId: getVnfPkgsContent
1156 $ref: '#/components/schemas/ArrayOfVnfPkgInfo'
1159 $ref: '#/components/schemas/ArrayOfVnfPkgInfo'
1161 description: Partial Content
1167 application/octet-stream:
1172 $ref: '#/components/responses/BadRequest'
1174 $ref: '#/components/responses/Unauthorized'
1176 $ref: '#/components/responses/Forbidden'
1178 $ref: '#/components/responses/NotFound'
1180 $ref: '#/components/responses/MethodNotAllowed'
1182 $ref: '#/components/responses/NotAcceptable'
1184 $ref: '#/components/responses/Conflict'
1186 $ref: '#/components/responses/UnprocessableEntity'
1188 $ref: '#/components/responses/InternalServerError'
1190 $ref: '#/components/responses/ServiceUnavailable'
1192 $ref: '#/components/responses/UnexpectedError'
1194 $ref: '#/components/responses/UnexpectedError'
1195 '/vnfpkgm/v1/vnf_packages_content/{packageContentId}':
1197 - name: packageContentId
1200 description: VNF Package Content ID
1206 summary: Read information about an individual VNF package resource
1207 description: Read information about an individual VNF package resource
1208 operationId: getVnfPkgsIdContent
1215 $ref: '#/components/schemas/VnfPkgInfo'
1218 $ref: '#/components/schemas/VnfPkgInfo'
1220 $ref: '#/components/responses/BadRequest'
1222 $ref: '#/components/responses/Unauthorized'
1224 $ref: '#/components/responses/Forbidden'
1226 $ref: '#/components/responses/NotFound'
1228 $ref: '#/components/responses/MethodNotAllowed'
1230 $ref: '#/components/responses/NotAcceptable'
1232 $ref: '#/components/responses/Conflict'
1234 $ref: '#/components/responses/UnprocessableEntity'
1236 $ref: '#/components/responses/InternalServerError'
1238 $ref: '#/components/responses/ServiceUnavailable'
1240 $ref: '#/components/responses/UnexpectedError'
1242 $ref: '#/components/responses/UnexpectedError'
1246 summary: Modify an individual VNF package resource
1247 description: Modify an individual VNF package resource
1248 operationId: updateVnfPkgsIdContent
1250 $ref: '#/components/requestBodies/VnfPkgInfoModifications'
1253 description: No Content
1255 $ref: '#/components/responses/BadRequest'
1257 $ref: '#/components/responses/Unauthorized'
1259 $ref: '#/components/responses/Forbidden'
1261 $ref: '#/components/responses/NotFound'
1263 $ref: '#/components/responses/MethodNotAllowed'
1265 $ref: '#/components/responses/NotAcceptable'
1267 $ref: '#/components/responses/Conflict'
1269 $ref: '#/components/responses/UnprocessableEntity'
1271 $ref: '#/components/responses/InternalServerError'
1273 $ref: '#/components/responses/ServiceUnavailable'
1275 $ref: '#/components/responses/UnexpectedError'
1277 $ref: '#/components/responses/UnexpectedError'
1281 summary: Delete an individual VNF package resource
1282 description: Delete an individual VNF package resource
1283 operationId: deleteVnfPkgsIdContent
1286 description: No Content
1288 $ref: '#/components/responses/BadRequest'
1290 $ref: '#/components/responses/Unauthorized'
1292 $ref: '#/components/responses/Forbidden'
1294 $ref: '#/components/responses/NotFound'
1296 $ref: '#/components/responses/MethodNotAllowed'
1298 $ref: '#/components/responses/NotAcceptable'
1300 $ref: '#/components/responses/Conflict'
1302 $ref: '#/components/responses/UnprocessableEntity'
1304 $ref: '#/components/responses/InternalServerError'
1306 $ref: '#/components/responses/ServiceUnavailable'
1308 $ref: '#/components/responses/UnexpectedError'
1310 $ref: '#/components/responses/UnexpectedError'
1313 # BEGIN NS Instances
1314 '/nslcm/v1/ns_instances':
1318 summary: Query information about multiple NS instances
1319 description: Query information about multiple NS isntances
1320 operationId: getNSinstances
1327 $ref: '#/components/schemas/ArrayOfNsInstance'
1330 $ref: '#/components/schemas/ArrayOfNsInstance'
1332 $ref: '#/components/responses/BadRequest'
1334 $ref: '#/components/responses/Unauthorized'
1336 $ref: '#/components/responses/Forbidden'
1338 $ref: '#/components/responses/NotFound'
1340 $ref: '#/components/responses/MethodNotAllowed'
1342 $ref: '#/components/responses/NotAcceptable'
1344 $ref: '#/components/responses/Conflict'
1346 $ref: '#/components/responses/UnprocessableEntity'
1348 $ref: '#/components/responses/InternalServerError'
1350 $ref: '#/components/responses/ServiceUnavailable'
1352 $ref: '#/components/responses/UnexpectedError'
1354 $ref: '#/components/responses/UnexpectedError'
1358 summary: Create a new NS instance resource
1359 description: Create a new NS instance resource
1360 operationId: addNSinstance
1362 $ref: '#/components/requestBodies/InstantiateNsRequest'
1365 description: Created
1374 $ref: '#/components/schemas/ObjectId'
1377 $ref: '#/components/schemas/ObjectId'
1379 $ref: '#/components/responses/BadRequest'
1381 $ref: '#/components/responses/Unauthorized'
1383 $ref: '#/components/responses/Forbidden'
1385 $ref: '#/components/responses/NotFound'
1387 $ref: '#/components/responses/MethodNotAllowed'
1389 $ref: '#/components/responses/NotAcceptable'
1391 $ref: '#/components/responses/Conflict'
1393 $ref: '#/components/responses/UnprocessableEntity'
1395 $ref: '#/components/responses/InternalServerError'
1397 $ref: '#/components/responses/ServiceUnavailable'
1399 $ref: '#/components/responses/UnexpectedError'
1401 $ref: '#/components/responses/UnexpectedError'
1402 '/nslcm/v1/ns_instances/{nsInstanceId}':
1404 - name: nsInstanceId
1407 description: NS Instance ID
1410 - name: vcaStatusRefresh
1413 description: Set to true if vca status needs to be refreshed.
1419 summary: Read an individual NS instance resource
1420 description: Read an individual NS instance resource
1421 operationId: getNSinstance
1428 $ref: '#/components/schemas/NsInstance'
1431 $ref: '#/components/schemas/NsInstance'
1433 $ref: '#/components/responses/BadRequest'
1435 $ref: '#/components/responses/Unauthorized'
1437 $ref: '#/components/responses/Forbidden'
1439 $ref: '#/components/responses/NotFound'
1441 $ref: '#/components/responses/MethodNotAllowed'
1443 $ref: '#/components/responses/NotAcceptable'
1445 $ref: '#/components/responses/Conflict'
1447 $ref: '#/components/responses/UnprocessableEntity'
1449 $ref: '#/components/responses/InternalServerError'
1451 $ref: '#/components/responses/ServiceUnavailable'
1453 $ref: '#/components/responses/UnexpectedError'
1455 $ref: '#/components/responses/UnexpectedError'
1459 summary: Delete an individual NS instance resource
1460 description: Delete an individual NS instance resource
1461 operationId: deleteNSinstance
1464 description: No Content
1466 $ref: '#/components/responses/BadRequest'
1468 $ref: '#/components/responses/Unauthorized'
1470 $ref: '#/components/responses/Forbidden'
1472 $ref: '#/components/responses/NotFound'
1474 $ref: '#/components/responses/MethodNotAllowed'
1476 $ref: '#/components/responses/NotAcceptable'
1478 $ref: '#/components/responses/Conflict'
1480 $ref: '#/components/responses/UnprocessableEntity'
1482 $ref: '#/components/responses/InternalServerError'
1484 $ref: '#/components/responses/ServiceUnavailable'
1486 $ref: '#/components/responses/UnexpectedError'
1488 $ref: '#/components/responses/UnexpectedError'
1489 '/nslcm/v1/ns_instances/{nsInstanceId}/instantiate':
1491 - name: nsInstanceId
1494 description: NS Instance ID
1500 summary: Instantiate a NS
1502 Instantiate a NS. The precondition is that the NS instance must have
1503 been created and must be in NOT_INSTANTIATED state. As a result of the
1504 success of this operation, the NFVO creates a "NS Lifecycle Operation
1505 Occurrence" resource for the request, and the NS instance state becomes
1507 operationId: instantiateNSinstance
1509 $ref: '#/components/requestBodies/InstantiateNsRequest'
1512 description: Accepted
1516 It must point to the new "NS Lifecycle Operation Occurrence"
1517 resource, i.e. an URI like ".../ns_lcm_op_occs/{nsLcmOpOccId}"
1524 $ref: '#/components/schemas/ObjectId'
1527 $ref: '#/components/schemas/ObjectId'
1529 $ref: '#/components/responses/BadRequest'
1531 $ref: '#/components/responses/Unauthorized'
1533 $ref: '#/components/responses/Forbidden'
1535 $ref: '#/components/responses/NotFound'
1537 $ref: '#/components/responses/MethodNotAllowed'
1539 $ref: '#/components/responses/NotAcceptable'
1541 $ref: '#/components/responses/Conflict'
1543 $ref: '#/components/responses/UnprocessableEntity'
1545 $ref: '#/components/responses/InternalServerError'
1547 $ref: '#/components/responses/ServiceUnavailable'
1549 $ref: '#/components/responses/UnexpectedError'
1551 $ref: '#/components/responses/UnexpectedError'
1552 '/nslcm/v1/ns_instances/{nsInstanceId}/scale':
1554 - name: nsInstanceId
1557 description: NS Instance ID
1563 summary: Scale a NS instance
1565 Scale a NS instance. The precondition is that the NS instance must have
1566 been created and must be in INSTANTIATED state. As a result of the
1567 success of this operation, the NFVO creates a "NS Lifecycle Operation
1568 Occurrence" resource for the request, and the NS instance state remains
1570 operationId: scaleNSinstance
1572 $ref: '#/components/requestBodies/ScaleNsRequest'
1575 description: Accepted
1579 It must point to the new "NS Lifecycle Operation Occurrence"
1580 resource, i.e. an URI like ".../ns_lcm_op_occs/{nsLcmOpOccId}"
1585 $ref: '#/components/responses/BadRequest'
1587 $ref: '#/components/responses/Unauthorized'
1589 $ref: '#/components/responses/Forbidden'
1591 $ref: '#/components/responses/NotFound'
1593 $ref: '#/components/responses/MethodNotAllowed'
1595 $ref: '#/components/responses/NotAcceptable'
1597 $ref: '#/components/responses/Conflict'
1599 $ref: '#/components/responses/UnprocessableEntity'
1601 $ref: '#/components/responses/InternalServerError'
1603 $ref: '#/components/responses/ServiceUnavailable'
1605 $ref: '#/components/responses/UnexpectedError'
1607 $ref: '#/components/responses/UnexpectedError'
1608 '/nslcm/v1/ns_instances/{nsInstanceId}/heal':
1610 - name: nsInstanceId
1613 description: NS Instance ID
1619 summary: Heal a NS instance
1621 Heal a NS instance. The precondition is that the NS instance must have
1622 been created and must be in INSTANTIATED state. As a result of the
1623 success of this operation, the NFVO creates a "NS Lifecycle Operation
1624 Occurrence" resource for the request, and the NS instance state remains
1626 operationId: healNSinstance
1628 $ref: '#/components/requestBodies/HealNsRequest'
1631 description: Accepted
1635 It must point to the new "NS Lifecycle Operation Occurrence"
1636 resource, i.e. an URI like ".../ns_lcm_op_occs/{nsLcmOpOccId}"
1641 $ref: '#/components/responses/BadRequest'
1643 $ref: '#/components/responses/Unauthorized'
1645 $ref: '#/components/responses/Forbidden'
1647 $ref: '#/components/responses/NotFound'
1649 $ref: '#/components/responses/MethodNotAllowed'
1651 $ref: '#/components/responses/NotAcceptable'
1653 $ref: '#/components/responses/Conflict'
1655 $ref: '#/components/responses/UnprocessableEntity'
1657 $ref: '#/components/responses/InternalServerError'
1659 $ref: '#/components/responses/ServiceUnavailable'
1661 $ref: '#/components/responses/UnexpectedError'
1663 $ref: '#/components/responses/UnexpectedError'
1664 '/nslcm/v1/ns_instances/{nsInstanceId}/terminate':
1666 - name: nsInstanceId
1669 description: NS Instance ID
1675 summary: Terminate a NS instance
1677 Terminate a NS instance. The precondition is that the NS instance must have
1678 been created and must be in INSTANTIATED state. As a result of the
1679 success of this operation, the NFVO creates a "NS Lifecycle Operation
1680 Occurrence" resource for the request, and the NS instance state becomes
1682 operationId: terminateNSinstance
1684 # Request data is not required
1685 $ref: '#/components/requestBodies/TerminateNsRequest'
1688 description: Accepted
1692 It must point to the new "NS Lifecycle Operation Occurrence"
1693 resource, i.e. an URI like ".../ns_lcm_op_occs/{nsLcmOpOccId}"
1700 $ref: '#/components/schemas/ObjectId'
1703 $ref: '#/components/schemas/ObjectId'
1705 $ref: '#/components/responses/BadRequest'
1707 $ref: '#/components/responses/Unauthorized'
1709 $ref: '#/components/responses/Forbidden'
1711 $ref: '#/components/responses/NotFound'
1713 $ref: '#/components/responses/MethodNotAllowed'
1715 $ref: '#/components/responses/NotAcceptable'
1717 $ref: '#/components/responses/Conflict'
1719 $ref: '#/components/responses/UnprocessableEntity'
1721 $ref: '#/components/responses/InternalServerError'
1723 $ref: '#/components/responses/ServiceUnavailable'
1725 $ref: '#/components/responses/UnexpectedError'
1727 $ref: '#/components/responses/UnexpectedError'
1728 '/nslcm/v1/ns_instances/{nsInstanceId}/action':
1730 - name: nsInstanceId
1733 description: NS Instance ID
1739 summary: Execute an action on a NS instance
1741 Execute an action on a NS instance.
1742 The NS instance must have been created and must be in INSTANTIATED state.
1743 operationId: actionOnNSinstance
1748 $ref: '#/components/schemas/NSinstanceActionRequest'
1751 $ref: '#/components/schemas/NSinstanceActionRequest'
1754 description: Accepted
1758 It must point to the new "NS Lifecycle Operation Occurrence"
1759 resource, i.e. an URI like ".../ns_lcm_op_occs/{nsLcmOpOccId}"
1766 $ref: '#/components/schemas/ObjectId'
1769 $ref: '#/components/schemas/ObjectId'
1771 $ref: '#/components/responses/BadRequest'
1773 $ref: '#/components/responses/Unauthorized'
1775 $ref: '#/components/responses/Forbidden'
1777 $ref: '#/components/responses/NotFound'
1779 $ref: '#/components/responses/MethodNotAllowed'
1781 $ref: '#/components/responses/NotAcceptable'
1783 $ref: '#/components/responses/Conflict'
1785 $ref: '#/components/responses/UnprocessableEntity'
1787 $ref: '#/components/responses/InternalServerError'
1789 $ref: '#/components/responses/ServiceUnavailable'
1791 $ref: '#/components/responses/UnexpectedError'
1793 $ref: '#/components/responses/UnexpectedError'
1794 '/nslcm/v1/ns_instances_content':
1798 summary: Query information about multiple NS instances
1799 description: Query information about multiple NS isntances
1800 operationId: getNSinstancesContent
1807 $ref: '#/components/schemas/ArrayOfNsInstance'
1810 $ref: '#/components/schemas/ArrayOfNsInstance'
1812 $ref: '#/components/responses/BadRequest'
1814 $ref: '#/components/responses/Unauthorized'
1816 $ref: '#/components/responses/Forbidden'
1818 $ref: '#/components/responses/NotFound'
1820 $ref: '#/components/responses/MethodNotAllowed'
1822 $ref: '#/components/responses/NotAcceptable'
1824 $ref: '#/components/responses/Conflict'
1826 $ref: '#/components/responses/UnprocessableEntity'
1828 $ref: '#/components/responses/InternalServerError'
1830 $ref: '#/components/responses/ServiceUnavailable'
1832 $ref: '#/components/responses/UnexpectedError'
1834 $ref: '#/components/responses/UnexpectedError'
1838 summary: Create a new NS instance
1839 description: Create a new NS instance
1840 operationId: createNSinstanceContent
1842 $ref: '#/components/requestBodies/InstantiateNsRequest'
1845 description: Created
1854 $ref: '#/components/schemas/CreateNSinstanceContentResponse'
1857 $ref: '#/components/schemas/CreateNSinstanceContentResponse'
1859 $ref: '#/components/responses/BadRequest'
1861 $ref: '#/components/responses/Unauthorized'
1863 $ref: '#/components/responses/Forbidden'
1865 $ref: '#/components/responses/NotFound'
1867 $ref: '#/components/responses/MethodNotAllowed'
1869 $ref: '#/components/responses/NotAcceptable'
1871 $ref: '#/components/responses/Conflict'
1873 $ref: '#/components/responses/UnprocessableEntity'
1875 $ref: '#/components/responses/InternalServerError'
1877 $ref: '#/components/responses/ServiceUnavailable'
1879 $ref: '#/components/responses/UnexpectedError'
1881 $ref: '#/components/responses/UnexpectedError'
1882 '/nslcm/v1/ns_instances_content/{nsInstanceContentId}':
1884 - name: nsInstanceContentId
1887 description: NS Instance Content ID
1893 summary: Read an individual NS instance resource
1894 description: Read an individual NS instance resource
1895 operationId: getNSinstanceContent
1902 $ref: '#/components/schemas/NsInstance'
1905 $ref: '#/components/schemas/NsInstance'
1907 $ref: '#/components/responses/BadRequest'
1909 $ref: '#/components/responses/Unauthorized'
1911 $ref: '#/components/responses/Forbidden'
1913 $ref: '#/components/responses/NotFound'
1915 $ref: '#/components/responses/MethodNotAllowed'
1917 $ref: '#/components/responses/NotAcceptable'
1919 $ref: '#/components/responses/Conflict'
1921 $ref: '#/components/responses/UnprocessableEntity'
1923 $ref: '#/components/responses/InternalServerError'
1925 $ref: '#/components/responses/ServiceUnavailable'
1927 $ref: '#/components/responses/UnexpectedError'
1929 $ref: '#/components/responses/UnexpectedError'
1933 summary: Delete an individual NS instance resource
1934 description: Delete an individual NS instance resource
1935 operationId: deleteNSinstanceContent
1938 description: Accepted
1942 $ref: '#/components/schemas/ObjectId'
1945 $ref: '#/components/schemas/ObjectId'
1947 description: No Content
1949 $ref: '#/components/responses/BadRequest'
1951 $ref: '#/components/responses/Unauthorized'
1953 $ref: '#/components/responses/Forbidden'
1955 $ref: '#/components/responses/NotFound'
1957 $ref: '#/components/responses/MethodNotAllowed'
1959 $ref: '#/components/responses/NotAcceptable'
1961 $ref: '#/components/responses/Conflict'
1963 $ref: '#/components/responses/UnprocessableEntity'
1965 $ref: '#/components/responses/InternalServerError'
1967 $ref: '#/components/responses/ServiceUnavailable'
1969 $ref: '#/components/responses/UnexpectedError'
1971 $ref: '#/components/responses/UnexpectedError'
1972 '/nslcm/v1/ns_lcm_op_occs':
1976 summary: Query information about multiple NS LCM Operation Occurrences
1977 description: Query information about multiple NS LCM Operation Occurrences
1978 operationId: getNSLCMOpOccs
1985 $ref: '#/components/schemas/ArrayOfNsLcmOpOcc'
1988 $ref: '#/components/schemas/ArrayOfNsLcmOpOcc'
1990 $ref: '#/components/responses/BadRequest'
1992 $ref: '#/components/responses/Unauthorized'
1994 $ref: '#/components/responses/Forbidden'
1996 $ref: '#/components/responses/NotFound'
1998 $ref: '#/components/responses/MethodNotAllowed'
2000 $ref: '#/components/responses/NotAcceptable'
2002 $ref: '#/components/responses/Conflict'
2004 $ref: '#/components/responses/UnprocessableEntity'
2006 $ref: '#/components/responses/InternalServerError'
2008 $ref: '#/components/responses/ServiceUnavailable'
2010 $ref: '#/components/responses/UnexpectedError'
2012 $ref: '#/components/responses/UnexpectedError'
2013 '/nslcm/v1/ns_lcm_op_occs/{nsLcmOpOccId}':
2015 - name: nsLcmOpOccId
2018 description: NS LCM Operation Occurrence ID
2024 summary: Query information about an individual NS LCM Operation Occurrence
2025 description: Query information about an individual NS LCM Operation Occurrence
2026 operationId: getNSLCMOpOcc
2033 $ref: '#/components/schemas/NsLcmOpOcc'
2036 $ref: '#/components/schemas/NsLcmOpOcc'
2038 $ref: '#/components/responses/BadRequest'
2040 $ref: '#/components/responses/Unauthorized'
2042 $ref: '#/components/responses/Forbidden'
2044 $ref: '#/components/responses/NotFound'
2046 $ref: '#/components/responses/MethodNotAllowed'
2048 $ref: '#/components/responses/NotAcceptable'
2050 $ref: '#/components/responses/Conflict'
2052 $ref: '#/components/responses/UnprocessableEntity'
2054 $ref: '#/components/responses/InternalServerError'
2056 $ref: '#/components/responses/ServiceUnavailable'
2058 $ref: '#/components/responses/UnexpectedError'
2060 $ref: '#/components/responses/UnexpectedError'
2061 '/nslcm/v1/vnf_instances':
2065 summary: Query information about multiple VNF Instances
2066 description: Query information about multiple VNF Instances
2067 operationId: getVnfInstances
2074 $ref: '#/components/schemas/ArrayOfVnfInstanceInfo'
2077 $ref: '#/components/schemas/ArrayOfVnfInstanceInfo'
2079 $ref: '#/components/responses/BadRequest'
2081 $ref: '#/components/responses/Unauthorized'
2083 $ref: '#/components/responses/Forbidden'
2085 $ref: '#/components/responses/NotFound'
2087 $ref: '#/components/responses/MethodNotAllowed'
2089 $ref: '#/components/responses/NotAcceptable'
2091 $ref: '#/components/responses/Conflict'
2093 $ref: '#/components/responses/UnprocessableEntity'
2095 $ref: '#/components/responses/InternalServerError'
2097 $ref: '#/components/responses/ServiceUnavailable'
2099 $ref: '#/components/responses/UnexpectedError'
2101 $ref: '#/components/responses/UnexpectedError'
2102 '/nslcm/v1/vnf_instances/{vnfInstanceId}':
2104 - name: vnfInstanceId
2107 description: VNF Instance ID
2113 summary: Query information about an individual VNF Instance
2114 description: Query information about an individual VNF Instance
2115 operationId: getVnfInstance
2122 $ref: '#/components/schemas/VnfInstanceInfo'
2125 $ref: '#/components/schemas/VnfInstanceInfo'
2127 $ref: '#/components/responses/BadRequest'
2129 $ref: '#/components/responses/Unauthorized'
2131 $ref: '#/components/responses/Forbidden'
2133 $ref: '#/components/responses/NotFound'
2135 $ref: '#/components/responses/MethodNotAllowed'
2137 $ref: '#/components/responses/NotAcceptable'
2139 $ref: '#/components/responses/Conflict'
2141 $ref: '#/components/responses/UnprocessableEntity'
2143 $ref: '#/components/responses/InternalServerError'
2145 $ref: '#/components/responses/ServiceUnavailable'
2147 $ref: '#/components/responses/UnexpectedError'
2149 $ref: '#/components/responses/UnexpectedError'
2150 '/nslcm/v1/subscriptions':
2154 summary: Query information about multiple NS instance subscription
2155 description: Query information about multiple NS instance subscription
2156 operationId: getNsSubcriptions
2163 $ref: '#/components/schemas/ArrayOfNslcmSubscriptionInfo'
2166 $ref: '#/components/schemas/ArrayOfNslcmSubscriptionInfo'
2168 $ref: '#/components/responses/BadRequest'
2170 $ref: '#/components/responses/Unauthorized'
2172 $ref: '#/components/responses/Forbidden'
2174 $ref: '#/components/responses/NotFound'
2176 $ref: '#/components/responses/MethodNotAllowed'
2178 $ref: '#/components/responses/NotAcceptable'
2180 $ref: '#/components/responses/Conflict'
2182 $ref: '#/components/responses/UnprocessableEntity'
2184 $ref: '#/components/responses/InternalServerError'
2186 $ref: '#/components/responses/ServiceUnavailable'
2188 $ref: '#/components/responses/UnexpectedError'
2190 $ref: '#/components/responses/UnexpectedError'
2194 summary: Create a new subscription for the Network service
2195 description: Create a new subscription for the Network service
2196 operationId: addNsSubcriptions
2198 $ref: '#/components/requestBodies/NslcmSubscriptionRequest'
2201 description: Created
2209 $ref: '#/components/schemas/NslcmSubscriptionResponse'
2212 $ref: '#/components/schemas/NslcmSubscriptionResponse'
2214 $ref: '#/components/responses/BadRequest'
2216 $ref: '#/components/responses/Unauthorized'
2218 $ref: '#/components/responses/Forbidden'
2220 $ref: '#/components/responses/NotFound'
2222 $ref: '#/components/responses/MethodNotAllowed'
2224 $ref: '#/components/responses/NotAcceptable'
2226 $ref: '#/components/responses/Conflict'
2228 $ref: '#/components/responses/UnprocessableEntity'
2230 $ref: '#/components/responses/InternalServerError'
2232 $ref: '#/components/responses/ServiceUnavailable'
2234 $ref: '#/components/responses/UnexpectedError'
2236 $ref: '#/components/responses/UnexpectedError'
2237 '/nslcm/v1/subscriptions/{nsSubscriptionsId}':
2239 - name: nsSubscriptionsId
2242 description: Network Service Subscription ID
2248 summary: Read information about an individual Network Service Subscription
2249 description: Read information about an individual Network Service Subscription
2250 operationId: getNsSubcriptionId
2257 $ref: '#/components/schemas/NslcmSubscriptionInfo'
2260 $ref: '#/components/schemas/NslcmSubscriptionInfo'
2262 $ref: '#/components/responses/BadRequest'
2264 $ref: '#/components/responses/Unauthorized'
2266 $ref: '#/components/responses/Forbidden'
2268 $ref: '#/components/responses/NotFound'
2270 $ref: '#/components/responses/MethodNotAllowed'
2272 $ref: '#/components/responses/NotAcceptable'
2274 $ref: '#/components/responses/Conflict'
2276 $ref: '#/components/responses/UnprocessableEntity'
2278 $ref: '#/components/responses/InternalServerError'
2280 $ref: '#/components/responses/ServiceUnavailable'
2282 $ref: '#/components/responses/UnexpectedError'
2284 $ref: '#/components/responses/UnexpectedError'
2288 summary: Delete an individual Network Service Subscription
2289 description: Delete an individual Network Service Subscription
2290 operationId: deleteNsSubcriptionId
2293 description: No Content
2295 $ref: '#/components/responses/BadRequest'
2297 $ref: '#/components/responses/Unauthorized'
2299 $ref: '#/components/responses/Forbidden'
2301 $ref: '#/components/responses/NotFound'
2303 $ref: '#/components/responses/MethodNotAllowed'
2305 $ref: '#/components/responses/NotAcceptable'
2307 $ref: '#/components/responses/Conflict'
2309 $ref: '#/components/responses/UnprocessableEntity'
2311 $ref: '#/components/responses/InternalServerError'
2313 $ref: '#/components/responses/ServiceUnavailable'
2315 $ref: '#/components/responses/UnexpectedError'
2317 $ref: '#/components/responses/UnexpectedError'
2325 summary: Query information about multiple alarms
2326 description: Query information about multiple alarms
2327 operationId: getAlarms
2334 $ref: '#/components/schemas/ArrayOfAlarm'
2337 $ref: '#/components/schemas/ArrayOfAlarm'
2339 $ref: '#/components/responses/BadRequest'
2341 $ref: '#/components/responses/Unauthorized'
2343 $ref: '#/components/responses/Forbidden'
2345 $ref: '#/components/responses/NotFound'
2347 $ref: '#/components/responses/MethodNotAllowed'
2349 $ref: '#/components/responses/NotAcceptable'
2351 $ref: '#/components/responses/Conflict'
2353 $ref: '#/components/responses/UnprocessableEntity'
2355 $ref: '#/components/responses/InternalServerError'
2357 $ref: '#/components/responses/ServiceUnavailable'
2359 $ref: '#/components/responses/UnexpectedError'
2361 $ref: '#/components/responses/UnexpectedError'
2362 '/nsfm/v1/alarms/{uuid}':
2367 description: Alarm UUID
2373 summary: Read an individual Alarm
2374 description: Read an individual Alarm
2375 operationId: getAlarm
2382 $ref: '#/components/schemas/Alarm'
2385 $ref: '#/components/schemas/Alarm'
2387 $ref: '#/components/responses/BadRequest'
2389 $ref: '#/components/responses/Unauthorized'
2391 $ref: '#/components/responses/Forbidden'
2393 $ref: '#/components/responses/NotFound'
2395 $ref: '#/components/responses/MethodNotAllowed'
2397 $ref: '#/components/responses/NotAcceptable'
2399 $ref: '#/components/responses/Conflict'
2401 $ref: '#/components/responses/UnprocessableEntity'
2403 $ref: '#/components/responses/InternalServerError'
2405 $ref: '#/components/responses/ServiceUnavailable'
2407 $ref: '#/components/responses/UnexpectedError'
2409 $ref: '#/components/responses/UnexpectedError'
2413 summary: Modify the data of an individual Alarm
2414 description: Modify the data of an individual Alarm
2415 operationId: updateAlarm
2417 $ref: '#/components/requestBodies/AlarmInfoModifications'
2420 description: No Content
2422 $ref: '#/components/responses/BadRequest'
2424 $ref: '#/components/responses/Unauthorized'
2426 $ref: '#/components/responses/Forbidden'
2428 $ref: '#/components/responses/NotFound'
2430 $ref: '#/components/responses/MethodNotAllowed'
2432 $ref: '#/components/responses/NotAcceptable'
2434 $ref: '#/components/responses/Conflict'
2436 $ref: '#/components/responses/UnprocessableEntity'
2438 $ref: '#/components/responses/InternalServerError'
2440 $ref: '#/components/responses/ServiceUnavailable'
2442 $ref: '#/components/responses/UnexpectedError'
2444 $ref: '#/components/responses/UnexpectedError'
2447 # BEGIN NetSlice Templates
2448 '/nst/v1/netslice_templates':
2451 - "NetSlice templates"
2452 summary: Query information about multiple NetSlice template resources
2453 description: Query information about multiple NetSlice template resources
2454 operationId: getNSTs
2461 $ref: '#/components/schemas/ArrayOfNstInfo'
2464 $ref: '#/components/schemas/ArrayOfNstInfo'
2466 $ref: '#/components/responses/BadRequest'
2468 $ref: '#/components/responses/Unauthorized'
2470 $ref: '#/components/responses/Forbidden'
2472 $ref: '#/components/responses/NotFound'
2474 $ref: '#/components/responses/MethodNotAllowed'
2476 $ref: '#/components/responses/NotAcceptable'
2478 $ref: '#/components/responses/Conflict'
2480 $ref: '#/components/responses/UnprocessableEntity'
2482 $ref: '#/components/responses/InternalServerError'
2484 $ref: '#/components/responses/ServiceUnavailable'
2486 $ref: '#/components/responses/UnexpectedError'
2488 $ref: '#/components/responses/UnexpectedError'
2491 - "NetSlice templates"
2492 summary: Create a new NetSlice template resource
2493 description: Create a new NetSlice template resource
2496 $ref: '#/components/requestBodies/CreateNstInfoRequest'
2499 description: Created
2508 $ref: '#/components/schemas/ObjectId'
2511 $ref: '#/components/schemas/ObjectId'
2513 $ref: '#/components/responses/BadRequest'
2515 $ref: '#/components/responses/Unauthorized'
2517 $ref: '#/components/responses/Forbidden'
2519 $ref: '#/components/responses/NotFound'
2521 $ref: '#/components/responses/MethodNotAllowed'
2523 $ref: '#/components/responses/NotAcceptable'
2525 $ref: '#/components/responses/Conflict'
2527 $ref: '#/components/responses/UnprocessableEntity'
2529 $ref: '#/components/responses/InternalServerError'
2531 $ref: '#/components/responses/ServiceUnavailable'
2533 $ref: '#/components/responses/UnexpectedError'
2535 $ref: '#/components/responses/UnexpectedError'
2536 '/nst/v1/netslice_templates/{netsliceTemplateId}':
2538 - name: netsliceTemplateId
2541 description: NetSlice Template ID
2546 - "NetSlice templates"
2547 summary: Read information about an individual NetSlice template resource
2548 description: Read information about an individual NetSlice template resource
2556 $ref: '#/components/schemas/NstInfo'
2559 $ref: '#/components/schemas/NstInfo'
2561 $ref: '#/components/responses/BadRequest'
2563 $ref: '#/components/responses/Unauthorized'
2565 $ref: '#/components/responses/Forbidden'
2567 $ref: '#/components/responses/NotFound'
2569 $ref: '#/components/responses/MethodNotAllowed'
2571 $ref: '#/components/responses/NotAcceptable'
2573 $ref: '#/components/responses/Conflict'
2575 $ref: '#/components/responses/UnprocessableEntity'
2577 $ref: '#/components/responses/InternalServerError'
2579 $ref: '#/components/responses/ServiceUnavailable'
2581 $ref: '#/components/responses/UnexpectedError'
2583 $ref: '#/components/responses/UnexpectedError'
2586 - "NetSlice templates"
2587 summary: Delete an individual NetSlice template resource
2588 description: Delete an individual NetSlice template resource
2589 operationId: deleteNST
2592 description: No Content
2594 $ref: '#/components/responses/BadRequest'
2596 $ref: '#/components/responses/Unauthorized'
2598 $ref: '#/components/responses/Forbidden'
2600 $ref: '#/components/responses/NotFound'
2602 $ref: '#/components/responses/MethodNotAllowed'
2604 $ref: '#/components/responses/NotAcceptable'
2606 $ref: '#/components/responses/Conflict'
2608 $ref: '#/components/responses/UnprocessableEntity'
2610 $ref: '#/components/responses/InternalServerError'
2612 $ref: '#/components/responses/ServiceUnavailable'
2614 $ref: '#/components/responses/UnexpectedError'
2616 $ref: '#/components/responses/UnexpectedError'
2617 '/nst/v1/netslice_templates/{netsliceTemplateId}/artifacts/{artifactPath}':
2619 - name: netsliceTemplateId
2622 description: NetSlice Template ID
2625 - name: artifactPath
2628 description: Artifact Path
2633 - "NetSlice templates"
2634 summary: Fetch individual NetSlice Template artifact
2635 description: Fetch individual NetSlice Template artifact
2636 operationId: getNstArtifact
2641 application/octet-stream:
2646 description: Partial Content
2652 application/octet-stream:
2657 $ref: '#/components/responses/BadRequest'
2659 $ref: '#/components/responses/Unauthorized'
2661 $ref: '#/components/responses/Forbidden'
2663 $ref: '#/components/responses/NotFound'
2665 $ref: '#/components/responses/MethodNotAllowed'
2667 $ref: '#/components/responses/NotAcceptable'
2669 $ref: '#/components/responses/Conflict'
2671 $ref: '#/components/responses/UnprocessableEntity'
2673 $ref: '#/components/responses/InternalServerError'
2675 $ref: '#/components/responses/ServiceUnavailable'
2677 $ref: '#/components/responses/UnexpectedError'
2679 $ref: '#/components/responses/UnexpectedError'
2680 '/nst/v1/netslice_templates/{netsliceTemplateId}/nst':
2682 - name: netsliceTemplateId
2685 description: NetSlice Template ID
2690 - "NetSlice templates"
2691 summary: Read NST of an on-boarded NetSlice Template
2692 description: Read NST of an on-boarded NetSlice Template
2693 operationId: getNstNst
2700 $ref: '#/components/schemas/NetSliceTemplate'
2702 $ref: '#/components/responses/BadRequest'
2704 $ref: '#/components/responses/Unauthorized'
2706 $ref: '#/components/responses/Forbidden'
2708 $ref: '#/components/responses/NotFound'
2710 $ref: '#/components/responses/MethodNotAllowed'
2712 $ref: '#/components/responses/NotAcceptable'
2714 $ref: '#/components/responses/Conflict'
2716 $ref: '#/components/responses/UnprocessableEntity'
2718 $ref: '#/components/responses/InternalServerError'
2720 $ref: '#/components/responses/ServiceUnavailable'
2722 $ref: '#/components/responses/UnexpectedError'
2724 $ref: '#/components/responses/UnexpectedError'
2725 '/nst/v1/netslice_templates/{netsliceTemplateId}/nst_content':
2727 - name: netsliceTemplateId
2730 description: NetSlice Template ID
2735 - "NetSlice templates"
2736 summary: Fetch the content of a NST
2737 description: Fetch the content of a NST
2738 operationId: getNSTcontent
2745 $ref: '#/components/schemas/NetSlicePackage'
2747 description: Partial Content
2755 $ref: '#/components/schemas/NetSlicePackage'
2757 $ref: '#/components/responses/BadRequest'
2759 $ref: '#/components/responses/Unauthorized'
2761 $ref: '#/components/responses/Forbidden'
2763 $ref: '#/components/responses/NotFound'
2765 $ref: '#/components/responses/MethodNotAllowed'
2767 $ref: '#/components/responses/NotAcceptable'
2769 $ref: '#/components/responses/Conflict'
2771 $ref: '#/components/responses/UnprocessableEntity'
2773 $ref: '#/components/responses/InternalServerError'
2775 $ref: '#/components/responses/ServiceUnavailable'
2777 $ref: '#/components/responses/UnexpectedError'
2779 $ref: '#/components/responses/UnexpectedError'
2782 - "NetSlice templates"
2783 summary: Upload the content of a NST
2784 description: Upload the content of a NST
2785 operationId: updateNSTcontent
2787 $ref: '#/components/requestBodies/NetSlicePackage'
2790 description: Accepted
2792 description: No Content
2794 $ref: '#/components/responses/BadRequest'
2796 $ref: '#/components/responses/Unauthorized'
2798 $ref: '#/components/responses/Forbidden'
2800 $ref: '#/components/responses/NotFound'
2802 $ref: '#/components/responses/MethodNotAllowed'
2804 $ref: '#/components/responses/NotAcceptable'
2806 $ref: '#/components/responses/Conflict'
2808 $ref: '#/components/responses/UnprocessableEntity'
2810 $ref: '#/components/responses/InternalServerError'
2812 $ref: '#/components/responses/ServiceUnavailable'
2814 $ref: '#/components/responses/UnexpectedError'
2816 $ref: '#/components/responses/UnexpectedError'
2817 '/nst/v1/netslice_templates_content':
2820 - "NetSlice templates"
2821 summary: Upload a NetSlice package by providing the content of the NetSlice package
2822 description: Upload a NetSlice package by providing the content of the NetSlice package
2823 operationId: uploadNstContent
2828 $ref: '#/components/schemas/NetSlicePackage'
2831 description: Created
2840 $ref: '#/components/schemas/ObjectId'
2843 $ref: '#/components/schemas/ObjectId'
2845 description: Accepted
2847 description: No Content
2849 $ref: '#/components/responses/BadRequest'
2851 $ref: '#/components/responses/Unauthorized'
2853 $ref: '#/components/responses/Forbidden'
2855 $ref: '#/components/responses/NotFound'
2857 $ref: '#/components/responses/MethodNotAllowed'
2859 $ref: '#/components/responses/NotAcceptable'
2861 $ref: '#/components/responses/Conflict'
2863 $ref: '#/components/responses/UnprocessableEntity'
2865 $ref: '#/components/responses/InternalServerError'
2867 $ref: '#/components/responses/ServiceUnavailable'
2869 $ref: '#/components/responses/UnexpectedError'
2871 $ref: '#/components/responses/UnexpectedError'
2874 - "NetSlice templates"
2875 summary: Query information about multiple NetSlice Template resources
2876 description: Query information about multiple NetSlice Template resources
2877 operationId: getNstContent
2884 $ref: '#/components/schemas/ArrayOfNstInfo'
2887 $ref: '#/components/schemas/ArrayOfNstInfo'
2889 description: Partial Content
2895 application/octet-stream:
2900 $ref: '#/components/responses/BadRequest'
2902 $ref: '#/components/responses/Unauthorized'
2904 $ref: '#/components/responses/Forbidden'
2906 $ref: '#/components/responses/NotFound'
2908 $ref: '#/components/responses/MethodNotAllowed'
2910 $ref: '#/components/responses/NotAcceptable'
2912 $ref: '#/components/responses/Conflict'
2914 $ref: '#/components/responses/UnprocessableEntity'
2916 $ref: '#/components/responses/InternalServerError'
2918 $ref: '#/components/responses/ServiceUnavailable'
2920 $ref: '#/components/responses/UnexpectedError'
2922 $ref: '#/components/responses/UnexpectedError'
2923 '/nst/v1/netslice_templates_content/{netsliceTemplateContentId}':
2925 - name: netsliceTemplateContentId
2928 description: NetSlice Template ID
2933 - "NetSlice templates"
2934 summary: Read information about an individual NetSlice Template resource
2935 description: Read information about an individual NetSlice Template resource
2936 operationId: getNstIdContent
2943 $ref: '#/components/schemas/NstInfo'
2946 $ref: '#/components/schemas/NstInfo'
2948 $ref: '#/components/responses/BadRequest'
2950 $ref: '#/components/responses/Unauthorized'
2952 $ref: '#/components/responses/Forbidden'
2954 $ref: '#/components/responses/NotFound'
2956 $ref: '#/components/responses/MethodNotAllowed'
2958 $ref: '#/components/responses/NotAcceptable'
2960 $ref: '#/components/responses/Conflict'
2962 $ref: '#/components/responses/UnprocessableEntity'
2964 $ref: '#/components/responses/InternalServerError'
2966 $ref: '#/components/responses/ServiceUnavailable'
2968 $ref: '#/components/responses/UnexpectedError'
2970 $ref: '#/components/responses/UnexpectedError'
2973 - "NetSlice templates"
2974 summary: Modify an individual NetSlice Template resource
2975 description: Modify an individual NetSlice Template resource
2976 operationId: updateNstIdContent
2978 $ref: '#/components/requestBodies/NstInfoModifications'
2981 description: No Content
2983 $ref: '#/components/responses/BadRequest'
2985 $ref: '#/components/responses/Unauthorized'
2987 $ref: '#/components/responses/Forbidden'
2989 $ref: '#/components/responses/NotFound'
2991 $ref: '#/components/responses/MethodNotAllowed'
2993 $ref: '#/components/responses/NotAcceptable'
2995 $ref: '#/components/responses/Conflict'
2997 $ref: '#/components/responses/UnprocessableEntity'
2999 $ref: '#/components/responses/InternalServerError'
3001 $ref: '#/components/responses/ServiceUnavailable'
3003 $ref: '#/components/responses/UnexpectedError'
3005 $ref: '#/components/responses/UnexpectedError'
3008 - "NetSlice templates"
3009 summary: Delete an individual NetSlice Template resource
3010 description: Delete an individual NetSlice Template resource
3011 operationId: deleteNstIdContent
3014 description: No Content
3016 $ref: '#/components/responses/BadRequest'
3018 $ref: '#/components/responses/Unauthorized'
3020 $ref: '#/components/responses/Forbidden'
3022 $ref: '#/components/responses/NotFound'
3024 $ref: '#/components/responses/MethodNotAllowed'
3026 $ref: '#/components/responses/NotAcceptable'
3028 $ref: '#/components/responses/Conflict'
3030 $ref: '#/components/responses/UnprocessableEntity'
3032 $ref: '#/components/responses/InternalServerError'
3034 $ref: '#/components/responses/ServiceUnavailable'
3036 $ref: '#/components/responses/UnexpectedError'
3038 $ref: '#/components/responses/UnexpectedError'
3039 # END NetSlice Templates
3041 # BEGIN NetSlice Instances
3042 '/nsilcm/v1/netslice_instances':
3045 - "NetSlice instances"
3046 summary: Query information about multiple NetSlice instances
3047 description: Query information about multiple NetSlice isntances
3048 operationId: getNSIs
3055 $ref: '#/components/schemas/ArrayOfNetSliceInstance'
3058 $ref: '#/components/schemas/ArrayOfNetSliceInstance'
3060 $ref: '#/components/responses/BadRequest'
3062 $ref: '#/components/responses/Unauthorized'
3064 $ref: '#/components/responses/Forbidden'
3066 $ref: '#/components/responses/NotFound'
3068 $ref: '#/components/responses/MethodNotAllowed'
3070 $ref: '#/components/responses/NotAcceptable'
3072 $ref: '#/components/responses/Conflict'
3074 $ref: '#/components/responses/UnprocessableEntity'
3076 $ref: '#/components/responses/InternalServerError'
3078 $ref: '#/components/responses/ServiceUnavailable'
3080 $ref: '#/components/responses/UnexpectedError'
3082 $ref: '#/components/responses/UnexpectedError'
3085 - "NetSlice instances"
3086 summary: Create a new NetSlice instance resource
3087 description: Create a new NetSlice instance resource
3090 $ref: '#/components/requestBodies/InstantiateNsiRequest'
3093 description: Created
3102 $ref: '#/components/schemas/ObjectId'
3105 $ref: '#/components/schemas/ObjectId'
3107 $ref: '#/components/responses/BadRequest'
3109 $ref: '#/components/responses/Unauthorized'
3111 $ref: '#/components/responses/Forbidden'
3113 $ref: '#/components/responses/NotFound'
3115 $ref: '#/components/responses/MethodNotAllowed'
3117 $ref: '#/components/responses/NotAcceptable'
3119 $ref: '#/components/responses/Conflict'
3121 $ref: '#/components/responses/UnprocessableEntity'
3123 $ref: '#/components/responses/InternalServerError'
3125 $ref: '#/components/responses/ServiceUnavailable'
3127 $ref: '#/components/responses/UnexpectedError'
3129 $ref: '#/components/responses/UnexpectedError'
3130 '/nsilcm/v1/netslice_instances/{netsliceInstanceId}':
3132 - name: netsliceInstanceId
3135 description: NetSlice Instance ID
3140 - "NetSlice instances"
3141 summary: Read an individual NetSlice instance resource
3142 description: Read an individual NetSlice instance resource
3150 $ref: '#/components/schemas/NetSliceInstance'
3153 $ref: '#/components/schemas/NetSliceInstance'
3155 $ref: '#/components/responses/BadRequest'
3157 $ref: '#/components/responses/Unauthorized'
3159 $ref: '#/components/responses/Forbidden'
3161 $ref: '#/components/responses/NotFound'
3163 $ref: '#/components/responses/MethodNotAllowed'
3165 $ref: '#/components/responses/NotAcceptable'
3167 $ref: '#/components/responses/Conflict'
3169 $ref: '#/components/responses/UnprocessableEntity'
3171 $ref: '#/components/responses/InternalServerError'
3173 $ref: '#/components/responses/ServiceUnavailable'
3175 $ref: '#/components/responses/UnexpectedError'
3177 $ref: '#/components/responses/UnexpectedError'
3180 - "NetSlice instances"
3181 summary: Delete an individual NetSlice instance resource
3182 description: Delete an individual NetSlice instance resource
3183 operationId: deleteNSI
3186 description: No Content
3188 $ref: '#/components/responses/BadRequest'
3190 $ref: '#/components/responses/Unauthorized'
3192 $ref: '#/components/responses/Forbidden'
3194 $ref: '#/components/responses/NotFound'
3196 $ref: '#/components/responses/MethodNotAllowed'
3198 $ref: '#/components/responses/NotAcceptable'
3200 $ref: '#/components/responses/Conflict'
3202 $ref: '#/components/responses/UnprocessableEntity'
3204 $ref: '#/components/responses/InternalServerError'
3206 $ref: '#/components/responses/ServiceUnavailable'
3208 $ref: '#/components/responses/UnexpectedError'
3210 $ref: '#/components/responses/UnexpectedError'
3211 '/nsilcm/v1/netslice_instances/{netsliceInstanceId}/instantiate':
3213 - name: netsliceInstanceId
3216 description: NetSlice Instance ID
3221 - "NetSlice instances"
3222 summary: Instantiate a NetSlice
3224 Instantiate a NetSlice. The precondition is that the NetSlice instance
3225 must have been created and must be in NOT_INSTANTIATED state. As a result
3226 of the success of this operation, the NFVO creates a "NetSlice Lifecycle
3227 Operation Occurrence" resource for the request, and the NS instance state
3228 becomes INSTANTIATED.
3229 operationId: instantiateNSI
3231 $ref: '#/components/requestBodies/InstantiateNsiRequest'
3234 description: Accepted
3238 It must point to the new "NetSlice Lifecycle Operation Occurrence"
3239 resource, i.e. an URI like ".../nsi_lcm_op_occs/{nsiLcmOpOccId}"
3246 $ref: '#/components/schemas/ObjectId'
3249 $ref: '#/components/schemas/ObjectId'
3251 $ref: '#/components/responses/BadRequest'
3253 $ref: '#/components/responses/Unauthorized'
3255 $ref: '#/components/responses/Forbidden'
3257 $ref: '#/components/responses/NotFound'
3259 $ref: '#/components/responses/MethodNotAllowed'
3261 $ref: '#/components/responses/NotAcceptable'
3263 $ref: '#/components/responses/Conflict'
3265 $ref: '#/components/responses/UnprocessableEntity'
3267 $ref: '#/components/responses/InternalServerError'
3269 $ref: '#/components/responses/ServiceUnavailable'
3271 $ref: '#/components/responses/UnexpectedError'
3273 $ref: '#/components/responses/UnexpectedError'
3274 '/nsilcm/v1/netslice_instances/{netsliceInstanceId}/terminate':
3276 - name: netsliceInstanceId
3279 description: NetSlice Instance ID
3284 - "NetSlice instances"
3285 summary: Terminate a NetSlice instance
3287 Terminate a NetSlice instance. The precondition is that the NetSlice instance
3288 must have been created and must be in INSTANTIATED state. As a result of the
3289 success of this operation, the NFVO creates a "NetSlice Lifecycle Operation
3290 Occurrence" resource for the request, and the NetSlice instance state becomes
3292 operationId: terminateNSI
3294 # Request data is not required
3295 $ref: '#/components/requestBodies/TerminateNsiRequest'
3298 description: Accepted
3302 It must point to the new "NetSlice Lifecycle Operation Occurrence"
3303 resource, i.e. an URI like ".../nsi_lcm_op_occs/{nsiLcmOpOccId}"
3310 $ref: '#/components/schemas/ObjectId'
3313 $ref: '#/components/schemas/ObjectId'
3315 $ref: '#/components/responses/BadRequest'
3317 $ref: '#/components/responses/Unauthorized'
3319 $ref: '#/components/responses/Forbidden'
3321 $ref: '#/components/responses/NotFound'
3323 $ref: '#/components/responses/MethodNotAllowed'
3325 $ref: '#/components/responses/NotAcceptable'
3327 $ref: '#/components/responses/Conflict'
3329 $ref: '#/components/responses/UnprocessableEntity'
3331 $ref: '#/components/responses/InternalServerError'
3333 $ref: '#/components/responses/ServiceUnavailable'
3335 $ref: '#/components/responses/UnexpectedError'
3337 $ref: '#/components/responses/UnexpectedError'
3338 '/nsilcm/v1/netslice_instances/{netsliceInstanceId}/action':
3340 - name: netsliceInstanceId
3343 description: NetSlice Instance ID
3348 - "NetSlice instances"
3349 summary: Execute an action on a NetSlice instance
3351 Execute an action on a NetSlice instance.
3352 The NetSlice instance must have been created and must be in INSTANTIATED state.
3353 operationId: actionOnNSI
3358 $ref: '#/components/schemas/NsiActionRequest'
3361 $ref: '#/components/schemas/NsiActionRequest'
3364 description: Accepted
3368 It must point to the new "NS Lifecycle Operation Occurrence"
3369 resource, i.e. an URI like ".../ns_lcm_op_occs/{nsLcmOpOccId}"
3376 $ref: '#/components/schemas/ObjectId'
3379 $ref: '#/components/schemas/ObjectId'
3381 $ref: '#/components/responses/BadRequest'
3383 $ref: '#/components/responses/Unauthorized'
3385 $ref: '#/components/responses/Forbidden'
3387 $ref: '#/components/responses/NotFound'
3389 $ref: '#/components/responses/MethodNotAllowed'
3391 $ref: '#/components/responses/NotAcceptable'
3393 $ref: '#/components/responses/Conflict'
3395 $ref: '#/components/responses/UnprocessableEntity'
3397 $ref: '#/components/responses/InternalServerError'
3399 $ref: '#/components/responses/ServiceUnavailable'
3401 $ref: '#/components/responses/UnexpectedError'
3403 $ref: '#/components/responses/UnexpectedError'
3404 '/nsilcm/v1/netslice_instances_content':
3407 - "NetSlice instances"
3408 summary: Query information about multiple NetSlice instances
3409 description: Query information about multiple NetSlice isntances
3410 operationId: getNSIsContent
3417 $ref: '#/components/schemas/ArrayOfNetSliceInstance'
3420 $ref: '#/components/schemas/ArrayOfNetSliceInstance'
3422 $ref: '#/components/responses/BadRequest'
3424 $ref: '#/components/responses/Unauthorized'
3426 $ref: '#/components/responses/Forbidden'
3428 $ref: '#/components/responses/NotFound'
3430 $ref: '#/components/responses/MethodNotAllowed'
3432 $ref: '#/components/responses/NotAcceptable'
3434 $ref: '#/components/responses/Conflict'
3436 $ref: '#/components/responses/UnprocessableEntity'
3438 $ref: '#/components/responses/InternalServerError'
3440 $ref: '#/components/responses/ServiceUnavailable'
3442 $ref: '#/components/responses/UnexpectedError'
3444 $ref: '#/components/responses/UnexpectedError'
3447 - "NetSlice instances"
3448 summary: Create a new NetSlice instance
3449 description: Create a new NetSlice instance
3450 operationId: createNSIContent
3452 $ref: '#/components/requestBodies/InstantiateNsiRequest'
3455 description: Created
3464 $ref: '#/components/schemas/CreateNsiContentResponse'
3467 $ref: '#/components/schemas/CreateNsiContentResponse'
3469 $ref: '#/components/responses/BadRequest'
3471 $ref: '#/components/responses/Unauthorized'
3473 $ref: '#/components/responses/Forbidden'
3475 $ref: '#/components/responses/NotFound'
3477 $ref: '#/components/responses/MethodNotAllowed'
3479 $ref: '#/components/responses/NotAcceptable'
3481 $ref: '#/components/responses/Conflict'
3483 $ref: '#/components/responses/UnprocessableEntity'
3485 $ref: '#/components/responses/InternalServerError'
3487 $ref: '#/components/responses/ServiceUnavailable'
3489 $ref: '#/components/responses/UnexpectedError'
3491 $ref: '#/components/responses/UnexpectedError'
3492 '/nsilcm/v1/netslice_instances_content/{netsliceInstanceContentId}':
3494 - name: netsliceInstanceContentId
3497 description: NetSlice Instance Content ID
3502 - "NetSlice instances"
3503 summary: Read an individual NetSlice instance resource
3504 description: Read an individual NetSlice instance resource
3505 operationId: getNSIContent
3512 $ref: '#/components/schemas/NetSliceInstance'
3515 $ref: '#/components/schemas/NetSliceInstance'
3517 $ref: '#/components/responses/BadRequest'
3519 $ref: '#/components/responses/Unauthorized'
3521 $ref: '#/components/responses/Forbidden'
3523 $ref: '#/components/responses/NotFound'
3525 $ref: '#/components/responses/MethodNotAllowed'
3527 $ref: '#/components/responses/NotAcceptable'
3529 $ref: '#/components/responses/Conflict'
3531 $ref: '#/components/responses/UnprocessableEntity'
3533 $ref: '#/components/responses/InternalServerError'
3535 $ref: '#/components/responses/ServiceUnavailable'
3537 $ref: '#/components/responses/UnexpectedError'
3539 $ref: '#/components/responses/UnexpectedError'
3542 - "NetSlice instances"
3543 summary: Delete an individual NS instance resource
3544 description: Delete an individual NS instance resource
3545 operationId: deleteNSIContent
3548 description: Accepted
3552 $ref: '#/components/schemas/ObjectId'
3555 $ref: '#/components/schemas/ObjectId'
3557 description: No Content
3559 $ref: '#/components/responses/BadRequest'
3561 $ref: '#/components/responses/Unauthorized'
3563 $ref: '#/components/responses/Forbidden'
3565 $ref: '#/components/responses/NotFound'
3567 $ref: '#/components/responses/MethodNotAllowed'
3569 $ref: '#/components/responses/NotAcceptable'
3571 $ref: '#/components/responses/Conflict'
3573 $ref: '#/components/responses/UnprocessableEntity'
3575 $ref: '#/components/responses/InternalServerError'
3577 $ref: '#/components/responses/ServiceUnavailable'
3579 $ref: '#/components/responses/UnexpectedError'
3581 $ref: '#/components/responses/UnexpectedError'
3582 '/nsilcm/v1/nsi_lcm_op_occs':
3585 - "NetSlice instances"
3586 summary: Query information about multiple NetSlice LCM Operation Occurrences
3587 description: Query information about multiple NetSlice LCM Operation Occurrences
3588 operationId: getNsiLcmOpOccs
3595 $ref: '#/components/schemas/ArrayOfNsiLcmOpOcc'
3598 $ref: '#/components/schemas/ArrayOfNsiLcmOpOcc'
3600 $ref: '#/components/responses/BadRequest'
3602 $ref: '#/components/responses/Unauthorized'
3604 $ref: '#/components/responses/Forbidden'
3606 $ref: '#/components/responses/NotFound'
3608 $ref: '#/components/responses/MethodNotAllowed'
3610 $ref: '#/components/responses/NotAcceptable'
3612 $ref: '#/components/responses/Conflict'
3614 $ref: '#/components/responses/UnprocessableEntity'
3616 $ref: '#/components/responses/InternalServerError'
3618 $ref: '#/components/responses/ServiceUnavailable'
3620 $ref: '#/components/responses/UnexpectedError'
3622 $ref: '#/components/responses/UnexpectedError'
3623 '/nsilcm/v1/nsi_lcm_op_occs/{nsiLcmOpOccId}':
3625 - name: nsiLcmOpOccId
3628 description: NetSlice LCM Operation Occurrence ID
3633 - "NetSlice instances"
3634 summary: Query information about an individual NetSlice LCM Operation Occurrence
3635 description: Query information about an individual NetSlice LCM Operation Occurrence
3636 operationId: getNsiLcmOpOcc
3643 $ref: '#/components/schemas/NsiLcmOpOcc'
3646 $ref: '#/components/schemas/NsiLcmOpOcc'
3648 $ref: '#/components/responses/BadRequest'
3650 $ref: '#/components/responses/Unauthorized'
3652 $ref: '#/components/responses/Forbidden'
3654 $ref: '#/components/responses/NotFound'
3656 $ref: '#/components/responses/MethodNotAllowed'
3658 $ref: '#/components/responses/NotAcceptable'
3660 $ref: '#/components/responses/Conflict'
3662 $ref: '#/components/responses/UnprocessableEntity'
3664 $ref: '#/components/responses/InternalServerError'
3666 $ref: '#/components/responses/ServiceUnavailable'
3668 $ref: '#/components/responses/UnexpectedError'
3670 $ref: '#/components/responses/UnexpectedError'
3671 # END NetSlice Instances
3674 '/nspm/v1/pm_jobs/{pmJobId}/reports/{nsId}':
3679 description: NS PM Job ID
3690 - "NS Performance Management"
3691 summary: Query information about an individual NS PM Job Report
3692 description: Query information about an individual NS PM Job Report
3693 operationId: getNsPmJobReport
3700 $ref: '#/components/schemas/NsPmJobReportInfo'
3703 $ref: '#/components/schemas/NsPmJobReportInfo'
3705 $ref: '#/components/responses/BadRequest'
3707 $ref: '#/components/responses/Unauthorized'
3709 $ref: '#/components/responses/Forbidden'
3711 $ref: '#/components/responses/NotFound'
3713 $ref: '#/components/responses/MethodNotAllowed'
3715 $ref: '#/components/responses/NotAcceptable'
3717 $ref: '#/components/responses/Conflict'
3719 $ref: '#/components/responses/UnprocessableEntity'
3721 $ref: '#/components/responses/InternalServerError'
3723 $ref: '#/components/responses/ServiceUnavailable'
3725 $ref: '#/components/responses/UnexpectedError'
3727 $ref: '#/components/responses/UnexpectedError'
3731 '/pdu/v1/pdu_descriptors':
3734 - "Physical Data Units (PDU)"
3735 summary: Query information about multiple PDU Descriptors
3736 description: Query information about multiple PDU Descriptors
3737 operationId: getPDUs
3744 $ref: '#/components/schemas/ArrayOfPduInfo'
3747 $ref: '#/components/schemas/ArrayOfPduInfo'
3749 $ref: '#/components/responses/BadRequest'
3751 $ref: '#/components/responses/Unauthorized'
3753 $ref: '#/components/responses/Forbidden'
3755 $ref: '#/components/responses/NotFound'
3757 $ref: '#/components/responses/MethodNotAllowed'
3759 $ref: '#/components/responses/NotAcceptable'
3761 $ref: '#/components/responses/Conflict'
3763 $ref: '#/components/responses/UnprocessableEntity'
3765 $ref: '#/components/responses/InternalServerError'
3767 $ref: '#/components/responses/ServiceUnavailable'
3769 $ref: '#/components/responses/UnexpectedError'
3771 $ref: '#/components/responses/UnexpectedError'
3774 - "Physical Data Units (PDU)"
3775 summary: Create a new PDU
3776 description: Create a new PDU Descriptor
3777 operationId: createPDU
3779 $ref: '#/components/requestBodies/CreatePduRequest'
3791 $ref: '#/components/schemas/ObjectId'
3794 $ref: '#/components/schemas/ObjectId'
3796 $ref: '#/components/responses/BadRequest'
3798 $ref: '#/components/responses/Unauthorized'
3800 $ref: '#/components/responses/Forbidden'
3802 $ref: '#/components/responses/NotFound'
3804 $ref: '#/components/responses/MethodNotAllowed'
3806 $ref: '#/components/responses/NotAcceptable'
3808 $ref: '#/components/responses/Conflict'
3810 $ref: '#/components/responses/UnprocessableEntity'
3812 $ref: '#/components/responses/InternalServerError'
3814 $ref: '#/components/responses/ServiceUnavailable'
3816 $ref: '#/components/responses/UnexpectedError'
3818 $ref: '#/components/responses/UnexpectedError'
3819 '/pdu/v1/pdu_descriptors/{pduDescriptorId}':
3821 - name: pduDescriptorId
3824 description: PDU Descriptor ID
3829 - "Physical Data Units (PDU)"
3830 summary: Query information about an individual PDU Descriptor
3831 description: Query information about an individual PDU Descriptor
3839 $ref: '#/components/schemas/PduInfo'
3842 $ref: '#/components/schemas/PduInfo'
3844 $ref: '#/components/responses/BadRequest'
3846 $ref: '#/components/responses/Unauthorized'
3848 $ref: '#/components/responses/Forbidden'
3850 $ref: '#/components/responses/NotFound'
3852 $ref: '#/components/responses/MethodNotAllowed'
3854 $ref: '#/components/responses/NotAcceptable'
3856 $ref: '#/components/responses/Conflict'
3858 $ref: '#/components/responses/UnprocessableEntity'
3860 $ref: '#/components/responses/InternalServerError'
3862 $ref: '#/components/responses/ServiceUnavailable'
3864 $ref: '#/components/responses/UnexpectedError'
3866 $ref: '#/components/responses/UnexpectedError'
3869 - "Physical Data Units (PDU)"
3870 summary: Modify an individual PDU Descriptor
3871 description: Modify an individual PDU Descriptor
3872 operationId: editPDU
3874 $ref: '#/components/requestBodies/EditPduRequest'
3877 description: No Content
3879 $ref: '#/components/responses/BadRequest'
3881 $ref: '#/components/responses/Unauthorized'
3883 $ref: '#/components/responses/Forbidden'
3885 $ref: '#/components/responses/NotFound'
3887 $ref: '#/components/responses/MethodNotAllowed'
3889 $ref: '#/components/responses/NotAcceptable'
3891 $ref: '#/components/responses/Conflict'
3893 $ref: '#/components/responses/UnprocessableEntity'
3895 $ref: '#/components/responses/InternalServerError'
3897 $ref: '#/components/responses/ServiceUnavailable'
3899 $ref: '#/components/responses/UnexpectedError'
3901 $ref: '#/components/responses/UnexpectedError'
3904 - "Physical Data Units (PDU)"
3905 summary: Delete an individual PDU Descriptor
3906 description: Delete an individual PDU Descriptor
3907 operationId: deletePDU
3910 description: No Content
3912 $ref: '#/components/responses/BadRequest'
3914 $ref: '#/components/responses/Unauthorized'
3916 $ref: '#/components/responses/Forbidden'
3918 $ref: '#/components/responses/NotFound'
3920 $ref: '#/components/responses/MethodNotAllowed'
3922 $ref: '#/components/responses/NotAcceptable'
3924 $ref: '#/components/responses/Conflict'
3926 $ref: '#/components/responses/UnprocessableEntity'
3928 $ref: '#/components/responses/InternalServerError'
3930 $ref: '#/components/responses/ServiceUnavailable'
3932 $ref: '#/components/responses/UnexpectedError'
3934 $ref: '#/components/responses/UnexpectedError'
3943 summary: Query information about multiple Tokens
3944 description: Query information about multiple Tokens
3945 operationId: getTokens
3952 $ref: '#/components/schemas/ArrayOfTokenInfo'
3955 $ref: '#/components/schemas/ArrayOfTokenInfo'
3957 $ref: '#/components/responses/BadRequest'
3959 $ref: '#/components/responses/Unauthorized'
3961 $ref: '#/components/responses/Forbidden'
3963 $ref: '#/components/responses/NotFound'
3965 $ref: '#/components/responses/MethodNotAllowed'
3967 $ref: '#/components/responses/NotAcceptable'
3969 $ref: '#/components/responses/Conflict'
3971 $ref: '#/components/responses/UnprocessableEntity'
3973 $ref: '#/components/responses/InternalServerError'
3975 $ref: '#/components/responses/ServiceUnavailable'
3977 $ref: '#/components/responses/UnexpectedError'
3979 $ref: '#/components/responses/UnexpectedError'
3984 summary: Request a new Token
3985 description: Request a new Token
3986 operationId: createToken
3988 $ref: '#/components/requestBodies/CreateTokenRequest'
4001 - $ref: '#/components/schemas/TokenInfo'
4002 - $ref: '#/components/schemas/PasswordExpiryInfo'
4006 - $ref: '#/components/schemas/TokenInfo'
4007 - $ref: '#/components/schemas/PasswordExpiryInfo'
4009 $ref: '#/components/responses/BadRequest'
4011 $ref: '#/components/responses/Unauthorized'
4013 $ref: '#/components/responses/Forbidden'
4015 $ref: '#/components/responses/NotFound'
4017 $ref: '#/components/responses/MethodNotAllowed'
4019 $ref: '#/components/responses/NotAcceptable'
4021 $ref: '#/components/responses/Conflict'
4023 $ref: '#/components/responses/UnprocessableEntity'
4025 $ref: '#/components/responses/InternalServerError'
4027 $ref: '#/components/responses/ServiceUnavailable'
4029 $ref: '#/components/responses/UnexpectedError'
4031 $ref: '#/components/responses/UnexpectedError'
4036 summary: Delete the Token indicated in the Authorization Header
4037 description: Delete the Token indicated in the Authorization Header
4038 operationId: deleteAuthToken
4050 $ref: '#/components/responses/BadRequest'
4052 $ref: '#/components/responses/Unauthorized'
4054 $ref: '#/components/responses/Forbidden'
4056 $ref: '#/components/responses/NotFound'
4058 $ref: '#/components/responses/MethodNotAllowed'
4060 $ref: '#/components/responses/NotAcceptable'
4062 $ref: '#/components/responses/Conflict'
4064 $ref: '#/components/responses/UnprocessableEntity'
4066 $ref: '#/components/responses/InternalServerError'
4068 $ref: '#/components/responses/ServiceUnavailable'
4070 $ref: '#/components/responses/UnexpectedError'
4072 $ref: '#/components/responses/UnexpectedError'
4073 '/admin/v1/tokens/{tokenId}':
4078 description: Token ID
4085 summary: Query information about an individual Token
4086 description: Query information about an individual Token
4087 operationId: getToken
4094 $ref: '#/components/schemas/TokenInfo'
4097 $ref: '#/components/schemas/TokenInfo'
4099 $ref: '#/components/responses/BadRequest'
4101 $ref: '#/components/responses/Unauthorized'
4103 $ref: '#/components/responses/Forbidden'
4105 $ref: '#/components/responses/NotFound'
4107 $ref: '#/components/responses/MethodNotAllowed'
4109 $ref: '#/components/responses/NotAcceptable'
4111 $ref: '#/components/responses/Conflict'
4113 $ref: '#/components/responses/UnprocessableEntity'
4115 $ref: '#/components/responses/InternalServerError'
4117 $ref: '#/components/responses/ServiceUnavailable'
4119 $ref: '#/components/responses/UnexpectedError'
4121 $ref: '#/components/responses/UnexpectedError'
4126 summary: Delete the Token indicated as parameter
4127 description: Delete the Token indicated as parameter
4128 operationId: deleteToken
4140 $ref: '#/components/responses/BadRequest'
4142 $ref: '#/components/responses/Unauthorized'
4144 $ref: '#/components/responses/Forbidden'
4146 $ref: '#/components/responses/NotFound'
4148 $ref: '#/components/responses/MethodNotAllowed'
4150 $ref: '#/components/responses/NotAcceptable'
4152 $ref: '#/components/responses/Conflict'
4154 $ref: '#/components/responses/UnprocessableEntity'
4156 $ref: '#/components/responses/InternalServerError'
4158 $ref: '#/components/responses/ServiceUnavailable'
4160 $ref: '#/components/responses/UnexpectedError'
4162 $ref: '#/components/responses/UnexpectedError'
4168 summary: Query information about multiple Users
4169 description: Query information about multiple Users
4170 operationId: getUsers
4177 $ref: '#/components/schemas/ArrayOfUserInfo'
4180 $ref: '#/components/schemas/ArrayOfUserInfo'
4182 $ref: '#/components/responses/BadRequest'
4184 $ref: '#/components/responses/Unauthorized'
4186 $ref: '#/components/responses/Forbidden'
4188 $ref: '#/components/responses/NotFound'
4190 $ref: '#/components/responses/MethodNotAllowed'
4192 $ref: '#/components/responses/NotAcceptable'
4194 $ref: '#/components/responses/Conflict'
4196 $ref: '#/components/responses/UnprocessableEntity'
4198 $ref: '#/components/responses/InternalServerError'
4200 $ref: '#/components/responses/ServiceUnavailable'
4202 $ref: '#/components/responses/UnexpectedError'
4204 $ref: '#/components/responses/UnexpectedError'
4209 summary: Create a new User
4210 description: Create a new User
4211 operationId: createUser
4213 $ref: '#/components/requestBodies/CreateUserRequest'
4216 description: Created
4225 $ref: '#/components/schemas/ObjectId'
4228 $ref: '#/components/schemas/ObjectId'
4230 $ref: '#/components/responses/BadRequest'
4232 $ref: '#/components/responses/Unauthorized'
4234 $ref: '#/components/responses/Forbidden'
4236 $ref: '#/components/responses/NotFound'
4238 $ref: '#/components/responses/MethodNotAllowed'
4240 $ref: '#/components/responses/NotAcceptable'
4242 $ref: '#/components/responses/Conflict'
4244 $ref: '#/components/responses/UnprocessableEntity'
4246 $ref: '#/components/responses/InternalServerError'
4248 $ref: '#/components/responses/ServiceUnavailable'
4250 $ref: '#/components/responses/UnexpectedError'
4252 $ref: '#/components/responses/UnexpectedError'
4253 '/admin/v1/users/{userId}':
4258 description: User ID/Name
4265 summary: Query information about an individual User
4266 description: Query information about an individual User
4267 operationId: getUser
4274 $ref: '#/components/schemas/UserInfo'
4277 $ref: '#/components/schemas/UserInfo'
4279 $ref: '#/components/responses/BadRequest'
4281 $ref: '#/components/responses/Unauthorized'
4283 $ref: '#/components/responses/Forbidden'
4285 $ref: '#/components/responses/NotFound'
4287 $ref: '#/components/responses/MethodNotAllowed'
4289 $ref: '#/components/responses/NotAcceptable'
4291 $ref: '#/components/responses/Conflict'
4293 $ref: '#/components/responses/UnprocessableEntity'
4295 $ref: '#/components/responses/InternalServerError'
4297 $ref: '#/components/responses/ServiceUnavailable'
4299 $ref: '#/components/responses/UnexpectedError'
4301 $ref: '#/components/responses/UnexpectedError'
4306 summary: Modify a User
4307 description: Modify a User
4308 operationId: editUser
4310 $ref: '#/components/requestBodies/EditUserRequest'
4313 description: No Content
4315 $ref: '#/components/responses/BadRequest'
4317 $ref: '#/components/responses/Unauthorized'
4319 $ref: '#/components/responses/Forbidden'
4321 $ref: '#/components/responses/NotFound'
4323 $ref: '#/components/responses/MethodNotAllowed'
4325 $ref: '#/components/responses/NotAcceptable'
4327 $ref: '#/components/responses/Conflict'
4329 $ref: '#/components/responses/UnprocessableEntity'
4331 $ref: '#/components/responses/InternalServerError'
4333 $ref: '#/components/responses/ServiceUnavailable'
4335 $ref: '#/components/responses/UnexpectedError'
4337 $ref: '#/components/responses/UnexpectedError'
4342 summary: Delete a User
4343 description: Delete a User
4344 operationId: deleteUser
4347 description: No Content
4349 $ref: '#/components/responses/BadRequest'
4351 $ref: '#/components/responses/Unauthorized'
4353 $ref: '#/components/responses/Forbidden'
4355 $ref: '#/components/responses/NotFound'
4357 $ref: '#/components/responses/MethodNotAllowed'
4359 $ref: '#/components/responses/NotAcceptable'
4361 $ref: '#/components/responses/Conflict'
4363 $ref: '#/components/responses/UnprocessableEntity'
4365 $ref: '#/components/responses/InternalServerError'
4367 $ref: '#/components/responses/ServiceUnavailable'
4369 $ref: '#/components/responses/UnexpectedError'
4371 $ref: '#/components/responses/UnexpectedError'
4372 '/admin/v1/projects':
4377 summary: Query information about multiple Projects
4378 description: Query information about multiple Projects
4379 operationId: getProjects
4386 $ref: '#/components/schemas/ArrayOfProjectInfo'
4389 $ref: '#/components/schemas/ArrayOfProjectInfo'
4391 $ref: '#/components/responses/BadRequest'
4393 $ref: '#/components/responses/Unauthorized'
4395 $ref: '#/components/responses/Forbidden'
4397 $ref: '#/components/responses/NotFound'
4399 $ref: '#/components/responses/MethodNotAllowed'
4401 $ref: '#/components/responses/NotAcceptable'
4403 $ref: '#/components/responses/Conflict'
4405 $ref: '#/components/responses/UnprocessableEntity'
4407 $ref: '#/components/responses/InternalServerError'
4409 $ref: '#/components/responses/ServiceUnavailable'
4411 $ref: '#/components/responses/UnexpectedError'
4413 $ref: '#/components/responses/UnexpectedError'
4418 summary: Create a new Project
4419 description: Create a new Project
4420 operationId: createProject
4422 $ref: '#/components/requestBodies/CreateProjectRequest'
4425 description: Created
4434 $ref: '#/components/schemas/ObjectId'
4437 $ref: '#/components/schemas/ObjectId'
4439 $ref: '#/components/responses/BadRequest'
4441 $ref: '#/components/responses/Unauthorized'
4443 $ref: '#/components/responses/Forbidden'
4445 $ref: '#/components/responses/NotFound'
4447 $ref: '#/components/responses/MethodNotAllowed'
4449 $ref: '#/components/responses/NotAcceptable'
4451 $ref: '#/components/responses/Conflict'
4453 $ref: '#/components/responses/UnprocessableEntity'
4455 $ref: '#/components/responses/InternalServerError'
4457 $ref: '#/components/responses/ServiceUnavailable'
4459 $ref: '#/components/responses/UnexpectedError'
4461 $ref: '#/components/responses/UnexpectedError'
4462 '/admin/v1/projects/{projectId}':
4467 description: Project ID/Name
4474 summary: Query information about an individual Project
4475 description: Query information about an individual Project
4476 operationId: getProject
4483 $ref: '#/components/schemas/ProjectInfo'
4486 $ref: '#/components/schemas/ProjectInfo'
4488 $ref: '#/components/responses/BadRequest'
4490 $ref: '#/components/responses/Unauthorized'
4492 $ref: '#/components/responses/Forbidden'
4494 $ref: '#/components/responses/NotFound'
4496 $ref: '#/components/responses/MethodNotAllowed'
4498 $ref: '#/components/responses/NotAcceptable'
4500 $ref: '#/components/responses/Conflict'
4502 $ref: '#/components/responses/UnprocessableEntity'
4504 $ref: '#/components/responses/InternalServerError'
4506 $ref: '#/components/responses/ServiceUnavailable'
4508 $ref: '#/components/responses/UnexpectedError'
4510 $ref: '#/components/responses/UnexpectedError'
4515 summary: Modify a Project
4516 description: Modify a Project
4517 operationId: editProject
4519 $ref: '#/components/requestBodies/EditProjectRequest'
4522 description: No Content
4524 $ref: '#/components/responses/BadRequest'
4526 $ref: '#/components/responses/Unauthorized'
4528 $ref: '#/components/responses/Forbidden'
4530 $ref: '#/components/responses/NotFound'
4532 $ref: '#/components/responses/MethodNotAllowed'
4534 $ref: '#/components/responses/NotAcceptable'
4536 $ref: '#/components/responses/Conflict'
4538 $ref: '#/components/responses/UnprocessableEntity'
4540 $ref: '#/components/responses/InternalServerError'
4542 $ref: '#/components/responses/ServiceUnavailable'
4544 $ref: '#/components/responses/UnexpectedError'
4546 $ref: '#/components/responses/UnexpectedError'
4551 summary: Delete a Project
4552 description: Delete a Project
4553 operationId: deleteProject
4556 description: No Content
4558 $ref: '#/components/responses/BadRequest'
4560 $ref: '#/components/responses/Unauthorized'
4562 $ref: '#/components/responses/Forbidden'
4564 $ref: '#/components/responses/NotFound'
4566 $ref: '#/components/responses/MethodNotAllowed'
4568 $ref: '#/components/responses/NotAcceptable'
4570 $ref: '#/components/responses/Conflict'
4572 $ref: '#/components/responses/UnprocessableEntity'
4574 $ref: '#/components/responses/InternalServerError'
4576 $ref: '#/components/responses/ServiceUnavailable'
4578 $ref: '#/components/responses/UnexpectedError'
4580 $ref: '#/components/responses/UnexpectedError'
4586 summary: Query information about multiple Roles
4587 description: Query information about multiple Roles
4588 operationId: getRoles
4595 $ref: '#/components/schemas/ArrayOfRoleInfo'
4598 $ref: '#/components/schemas/ArrayOfRoleInfo'
4600 $ref: '#/components/responses/BadRequest'
4602 $ref: '#/components/responses/Unauthorized'
4604 $ref: '#/components/responses/Forbidden'
4606 $ref: '#/components/responses/NotFound'
4608 $ref: '#/components/responses/MethodNotAllowed'
4610 $ref: '#/components/responses/NotAcceptable'
4612 $ref: '#/components/responses/Conflict'
4614 $ref: '#/components/responses/UnprocessableEntity'
4616 $ref: '#/components/responses/InternalServerError'
4618 $ref: '#/components/responses/ServiceUnavailable'
4620 $ref: '#/components/responses/UnexpectedError'
4622 $ref: '#/components/responses/UnexpectedError'
4627 summary: Create a new Role
4628 description: Create a new Role
4629 operationId: createRole
4631 $ref: '#/components/requestBodies/CreateRoleRequest'
4634 description: Created
4643 $ref: '#/components/schemas/ObjectId'
4646 $ref: '#/components/schemas/ObjectId'
4648 $ref: '#/components/responses/BadRequest'
4650 $ref: '#/components/responses/Unauthorized'
4652 $ref: '#/components/responses/Forbidden'
4654 $ref: '#/components/responses/NotFound'
4656 $ref: '#/components/responses/MethodNotAllowed'
4658 $ref: '#/components/responses/NotAcceptable'
4660 $ref: '#/components/responses/Conflict'
4662 $ref: '#/components/responses/UnprocessableEntity'
4664 $ref: '#/components/responses/InternalServerError'
4666 $ref: '#/components/responses/ServiceUnavailable'
4668 $ref: '#/components/responses/UnexpectedError'
4670 $ref: '#/components/responses/UnexpectedError'
4671 '/admin/v1/roles/{roleId}':
4676 description: Role ID/Name
4683 summary: Query information about an individual Role
4684 description: Query information about an individual Role
4685 operationId: getRole
4692 $ref: '#/components/schemas/RoleInfo'
4695 $ref: '#/components/schemas/RoleInfo'
4697 $ref: '#/components/responses/BadRequest'
4699 $ref: '#/components/responses/Unauthorized'
4701 $ref: '#/components/responses/Forbidden'
4703 $ref: '#/components/responses/NotFound'
4705 $ref: '#/components/responses/MethodNotAllowed'
4707 $ref: '#/components/responses/NotAcceptable'
4709 $ref: '#/components/responses/Conflict'
4711 $ref: '#/components/responses/UnprocessableEntity'
4713 $ref: '#/components/responses/InternalServerError'
4715 $ref: '#/components/responses/ServiceUnavailable'
4717 $ref: '#/components/responses/UnexpectedError'
4719 $ref: '#/components/responses/UnexpectedError'
4724 summary: Modify a Role
4725 description: Modify a Role
4726 operationId: editRole
4728 $ref: '#/components/requestBodies/EditRoleRequest'
4731 description: No Content
4733 $ref: '#/components/responses/BadRequest'
4735 $ref: '#/components/responses/Unauthorized'
4737 $ref: '#/components/responses/Forbidden'
4739 $ref: '#/components/responses/NotFound'
4741 $ref: '#/components/responses/MethodNotAllowed'
4743 $ref: '#/components/responses/NotAcceptable'
4745 $ref: '#/components/responses/Conflict'
4747 $ref: '#/components/responses/UnprocessableEntity'
4749 $ref: '#/components/responses/InternalServerError'
4751 $ref: '#/components/responses/ServiceUnavailable'
4753 $ref: '#/components/responses/UnexpectedError'
4755 $ref: '#/components/responses/UnexpectedError'
4760 summary: Delete a Role
4761 description: Delete a Role
4762 operationId: deleteRole
4765 description: No Content
4767 $ref: '#/components/responses/BadRequest'
4769 $ref: '#/components/responses/Unauthorized'
4771 $ref: '#/components/responses/Forbidden'
4773 $ref: '#/components/responses/NotFound'
4775 $ref: '#/components/responses/MethodNotAllowed'
4777 $ref: '#/components/responses/NotAcceptable'
4779 $ref: '#/components/responses/Conflict'
4781 $ref: '#/components/responses/UnprocessableEntity'
4783 $ref: '#/components/responses/InternalServerError'
4785 $ref: '#/components/responses/ServiceUnavailable'
4787 $ref: '#/components/responses/UnexpectedError'
4789 $ref: '#/components/responses/UnexpectedError'
4795 summary: Query information about multiple VIMs
4796 description: Query information about multiple VIMs
4797 operationId: getVIMs
4804 $ref: '#/components/schemas/ArrayOfVimInfo'
4807 $ref: '#/components/schemas/ArrayOfVimInfo'
4809 $ref: '#/components/responses/BadRequest'
4811 $ref: '#/components/responses/Unauthorized'
4813 $ref: '#/components/responses/Forbidden'
4815 $ref: '#/components/responses/NotFound'
4817 $ref: '#/components/responses/MethodNotAllowed'
4819 $ref: '#/components/responses/NotAcceptable'
4821 $ref: '#/components/responses/Conflict'
4823 $ref: '#/components/responses/UnprocessableEntity'
4825 $ref: '#/components/responses/InternalServerError'
4827 $ref: '#/components/responses/ServiceUnavailable'
4829 $ref: '#/components/responses/UnexpectedError'
4831 $ref: '#/components/responses/UnexpectedError'
4836 summary: Create a new VIM
4837 description: Create a new VIM
4838 operationId: createVIM
4840 $ref: '#/components/requestBodies/CreateVimRequest'
4843 description: Accepted
4847 $ref: '#/components/schemas/ObjectId_plus_OpId'
4850 $ref: '#/components/schemas/ObjectId_plus_OpId'
4852 $ref: '#/components/responses/BadRequest'
4854 $ref: '#/components/responses/Unauthorized'
4856 $ref: '#/components/responses/Forbidden'
4858 $ref: '#/components/responses/NotFound'
4860 $ref: '#/components/responses/MethodNotAllowed'
4862 $ref: '#/components/responses/NotAcceptable'
4864 $ref: '#/components/responses/Conflict'
4866 $ref: '#/components/responses/UnprocessableEntity'
4868 $ref: '#/components/responses/InternalServerError'
4870 $ref: '#/components/responses/ServiceUnavailable'
4872 $ref: '#/components/responses/UnexpectedError'
4874 $ref: '#/components/responses/UnexpectedError'
4875 '/admin/v1/vims/{vimId}':
4888 summary: Query information about an individual VIM
4889 description: Query information about an individual VIM
4897 $ref: '#/components/schemas/VimInfo'
4900 $ref: '#/components/schemas/VimInfo'
4902 $ref: '#/components/responses/BadRequest'
4904 $ref: '#/components/responses/Unauthorized'
4906 $ref: '#/components/responses/Forbidden'
4908 $ref: '#/components/responses/NotFound'
4910 $ref: '#/components/responses/MethodNotAllowed'
4912 $ref: '#/components/responses/NotAcceptable'
4914 $ref: '#/components/responses/Conflict'
4916 $ref: '#/components/responses/UnprocessableEntity'
4918 $ref: '#/components/responses/InternalServerError'
4920 $ref: '#/components/responses/ServiceUnavailable'
4922 $ref: '#/components/responses/UnexpectedError'
4924 $ref: '#/components/responses/UnexpectedError'
4929 summary: Modify a VIM
4930 description: Modify a VIM
4931 operationId: editVIM
4933 $ref: '#/components/requestBodies/EditVimRequest'
4936 description: Accepted
4940 $ref: '#/components/schemas/OpId'
4943 $ref: '#/components/schemas/OpId'
4945 $ref: '#/components/responses/BadRequest'
4947 $ref: '#/components/responses/Unauthorized'
4949 $ref: '#/components/responses/Forbidden'
4951 $ref: '#/components/responses/NotFound'
4953 $ref: '#/components/responses/MethodNotAllowed'
4955 $ref: '#/components/responses/NotAcceptable'
4957 $ref: '#/components/responses/Conflict'
4959 $ref: '#/components/responses/UnprocessableEntity'
4961 $ref: '#/components/responses/InternalServerError'
4963 $ref: '#/components/responses/ServiceUnavailable'
4965 $ref: '#/components/responses/UnexpectedError'
4967 $ref: '#/components/responses/UnexpectedError'
4972 summary: Delete a VIM
4973 description: Delete a VIM
4974 operationId: deleteVIM
4977 description: Accepted
4979 $ref: '#/components/responses/BadRequest'
4981 $ref: '#/components/responses/Unauthorized'
4983 $ref: '#/components/responses/Forbidden'
4985 $ref: '#/components/responses/NotFound'
4987 $ref: '#/components/responses/MethodNotAllowed'
4989 $ref: '#/components/responses/NotAcceptable'
4991 $ref: '#/components/responses/Conflict'
4993 $ref: '#/components/responses/UnprocessableEntity'
4995 $ref: '#/components/responses/InternalServerError'
4997 $ref: '#/components/responses/ServiceUnavailable'
4999 $ref: '#/components/responses/UnexpectedError'
5001 $ref: '#/components/responses/UnexpectedError'
5002 '/admin/v1/vim_accounts':
5007 summary: Query information about multiple VIM Accounts
5008 description: Query information about multiple VIM Accounts
5009 operationId: getVimAccounts
5016 $ref: '#/components/schemas/ArrayOfVimInfo'
5019 $ref: '#/components/schemas/ArrayOfVimInfo'
5021 $ref: '#/components/responses/BadRequest'
5023 $ref: '#/components/responses/Unauthorized'
5025 $ref: '#/components/responses/Forbidden'
5027 $ref: '#/components/responses/NotFound'
5029 $ref: '#/components/responses/MethodNotAllowed'
5031 $ref: '#/components/responses/NotAcceptable'
5033 $ref: '#/components/responses/Conflict'
5035 $ref: '#/components/responses/UnprocessableEntity'
5037 $ref: '#/components/responses/InternalServerError'
5039 $ref: '#/components/responses/ServiceUnavailable'
5041 $ref: '#/components/responses/UnexpectedError'
5043 $ref: '#/components/responses/UnexpectedError'
5048 summary: Create a new VIM Account
5049 description: Create a new VIM Account
5050 operationId: createVimAccount
5052 $ref: '#/components/requestBodies/CreateVimRequest'
5055 description: Accepted
5059 $ref: '#/components/schemas/ObjectId_plus_OpId'
5062 $ref: '#/components/schemas/ObjectId_plus_OpId'
5064 $ref: '#/components/responses/BadRequest'
5066 $ref: '#/components/responses/Unauthorized'
5068 $ref: '#/components/responses/Forbidden'
5070 $ref: '#/components/responses/NotFound'
5072 $ref: '#/components/responses/MethodNotAllowed'
5074 $ref: '#/components/responses/NotAcceptable'
5076 $ref: '#/components/responses/Conflict'
5078 $ref: '#/components/responses/UnprocessableEntity'
5080 $ref: '#/components/responses/InternalServerError'
5082 $ref: '#/components/responses/ServiceUnavailable'
5084 $ref: '#/components/responses/UnexpectedError'
5086 $ref: '#/components/responses/UnexpectedError'
5087 '/admin/v1/vim_accounts/{vimAccountId}':
5089 - name: vimAccountId
5092 description: VIM Account ID
5100 summary: Query information about an individual VIM Account
5101 description: Query information about an individual VIM Account
5102 operationId: getVimAccount
5109 $ref: '#/components/schemas/VimInfo'
5112 $ref: '#/components/schemas/VimInfo'
5114 $ref: '#/components/responses/BadRequest'
5116 $ref: '#/components/responses/Unauthorized'
5118 $ref: '#/components/responses/Forbidden'
5120 $ref: '#/components/responses/NotFound'
5122 $ref: '#/components/responses/MethodNotAllowed'
5124 $ref: '#/components/responses/NotAcceptable'
5126 $ref: '#/components/responses/Conflict'
5128 $ref: '#/components/responses/UnprocessableEntity'
5130 $ref: '#/components/responses/InternalServerError'
5132 $ref: '#/components/responses/ServiceUnavailable'
5134 $ref: '#/components/responses/UnexpectedError'
5136 $ref: '#/components/responses/UnexpectedError'
5141 summary: Modify a VIM Account
5142 description: Modify a VIM Account
5143 operationId: editVimAccount
5145 $ref: '#/components/requestBodies/EditVimRequest'
5148 description: Accepted
5152 $ref: '#/components/schemas/OpId'
5155 $ref: '#/components/schemas/OpId'
5157 $ref: '#/components/responses/BadRequest'
5159 $ref: '#/components/responses/Unauthorized'
5161 $ref: '#/components/responses/Forbidden'
5163 $ref: '#/components/responses/NotFound'
5165 $ref: '#/components/responses/MethodNotAllowed'
5167 $ref: '#/components/responses/NotAcceptable'
5169 $ref: '#/components/responses/Conflict'
5171 $ref: '#/components/responses/UnprocessableEntity'
5173 $ref: '#/components/responses/InternalServerError'
5175 $ref: '#/components/responses/ServiceUnavailable'
5177 $ref: '#/components/responses/UnexpectedError'
5179 $ref: '#/components/responses/UnexpectedError'
5184 summary: Delete a VIM Account
5185 description: Delete a VIM Account
5186 operationId: deleteVimAccount
5189 description: Accepted
5191 $ref: '#/components/responses/BadRequest'
5193 $ref: '#/components/responses/Unauthorized'
5195 $ref: '#/components/responses/Forbidden'
5197 $ref: '#/components/responses/NotFound'
5199 $ref: '#/components/responses/MethodNotAllowed'
5201 $ref: '#/components/responses/NotAcceptable'
5203 $ref: '#/components/responses/Conflict'
5205 $ref: '#/components/responses/UnprocessableEntity'
5207 $ref: '#/components/responses/InternalServerError'
5209 $ref: '#/components/responses/ServiceUnavailable'
5211 $ref: '#/components/responses/UnexpectedError'
5213 $ref: '#/components/responses/UnexpectedError'
5214 '/admin/v1/wim_accounts':
5219 summary: Query information about multiple WIM Accounts
5220 description: Query information about multiple WIM Accounts
5221 operationId: getWimAccounts
5228 $ref: '#/components/schemas/ArrayOfWimInfo'
5231 $ref: '#/components/schemas/ArrayOfWimInfo'
5233 $ref: '#/components/responses/BadRequest'
5235 $ref: '#/components/responses/Unauthorized'
5237 $ref: '#/components/responses/Forbidden'
5239 $ref: '#/components/responses/NotFound'
5241 $ref: '#/components/responses/MethodNotAllowed'
5243 $ref: '#/components/responses/NotAcceptable'
5245 $ref: '#/components/responses/Conflict'
5247 $ref: '#/components/responses/UnprocessableEntity'
5249 $ref: '#/components/responses/InternalServerError'
5251 $ref: '#/components/responses/ServiceUnavailable'
5253 $ref: '#/components/responses/UnexpectedError'
5255 $ref: '#/components/responses/UnexpectedError'
5260 summary: Create a new WIM Account
5261 description: Create a new WIM Account
5262 operationId: createWimAccount
5264 $ref: '#/components/requestBodies/CreateWimRequest'
5267 description: Accepted
5271 $ref: '#/components/schemas/ObjectId_plus_OpId'
5274 $ref: '#/components/schemas/ObjectId_plus_OpId'
5276 $ref: '#/components/responses/BadRequest'
5278 $ref: '#/components/responses/Unauthorized'
5280 $ref: '#/components/responses/Forbidden'
5282 $ref: '#/components/responses/NotFound'
5284 $ref: '#/components/responses/MethodNotAllowed'
5286 $ref: '#/components/responses/NotAcceptable'
5288 $ref: '#/components/responses/Conflict'
5290 $ref: '#/components/responses/UnprocessableEntity'
5292 $ref: '#/components/responses/InternalServerError'
5294 $ref: '#/components/responses/ServiceUnavailable'
5296 $ref: '#/components/responses/UnexpectedError'
5298 $ref: '#/components/responses/UnexpectedError'
5299 '/admin/v1/wim_accounts/{wimAccountId}':
5301 - name: wimAccountId
5304 description: WIM Account ID
5312 summary: Query information about an individual WIM Account
5313 description: Query information about an individual WIM Account
5314 operationId: getWimAccount
5321 $ref: '#/components/schemas/WimInfo'
5324 $ref: '#/components/schemas/WimInfo'
5326 $ref: '#/components/responses/BadRequest'
5328 $ref: '#/components/responses/Unauthorized'
5330 $ref: '#/components/responses/Forbidden'
5332 $ref: '#/components/responses/NotFound'
5334 $ref: '#/components/responses/MethodNotAllowed'
5336 $ref: '#/components/responses/NotAcceptable'
5338 $ref: '#/components/responses/Conflict'
5340 $ref: '#/components/responses/UnprocessableEntity'
5342 $ref: '#/components/responses/InternalServerError'
5344 $ref: '#/components/responses/ServiceUnavailable'
5346 $ref: '#/components/responses/UnexpectedError'
5348 $ref: '#/components/responses/UnexpectedError'
5353 summary: Modify a WIM Account
5354 description: Modify a WIM Account
5355 operationId: editWimAccount
5357 $ref: '#/components/requestBodies/EditWimRequest'
5360 description: Accepted
5364 $ref: '#/components/schemas/OpId'
5367 $ref: '#/components/schemas/OpId'
5369 $ref: '#/components/responses/BadRequest'
5371 $ref: '#/components/responses/Unauthorized'
5373 $ref: '#/components/responses/Forbidden'
5375 $ref: '#/components/responses/NotFound'
5377 $ref: '#/components/responses/MethodNotAllowed'
5379 $ref: '#/components/responses/NotAcceptable'
5381 $ref: '#/components/responses/Conflict'
5383 $ref: '#/components/responses/UnprocessableEntity'
5385 $ref: '#/components/responses/InternalServerError'
5387 $ref: '#/components/responses/ServiceUnavailable'
5389 $ref: '#/components/responses/UnexpectedError'
5391 $ref: '#/components/responses/UnexpectedError'
5396 summary: Delete a WIM Account
5397 description: Delete a WIM Account
5398 operationId: deleteWimAccount
5401 description: Accepted
5403 $ref: '#/components/responses/BadRequest'
5405 $ref: '#/components/responses/Unauthorized'
5407 $ref: '#/components/responses/Forbidden'
5409 $ref: '#/components/responses/NotFound'
5411 $ref: '#/components/responses/MethodNotAllowed'
5413 $ref: '#/components/responses/NotAcceptable'
5415 $ref: '#/components/responses/Conflict'
5417 $ref: '#/components/responses/UnprocessableEntity'
5419 $ref: '#/components/responses/InternalServerError'
5421 $ref: '#/components/responses/ServiceUnavailable'
5423 $ref: '#/components/responses/UnexpectedError'
5425 $ref: '#/components/responses/UnexpectedError'
5431 summary: Query information about multiple SDNs
5432 description: Query information about multiple SDNs
5433 operationId: getSDNs
5440 $ref: '#/components/schemas/ArrayOfSdnInfo'
5443 $ref: '#/components/schemas/ArrayOfSdnInfo'
5445 $ref: '#/components/responses/BadRequest'
5447 $ref: '#/components/responses/Unauthorized'
5449 $ref: '#/components/responses/Forbidden'
5451 $ref: '#/components/responses/NotFound'
5453 $ref: '#/components/responses/MethodNotAllowed'
5455 $ref: '#/components/responses/NotAcceptable'
5457 $ref: '#/components/responses/Conflict'
5459 $ref: '#/components/responses/UnprocessableEntity'
5461 $ref: '#/components/responses/InternalServerError'
5463 $ref: '#/components/responses/ServiceUnavailable'
5465 $ref: '#/components/responses/UnexpectedError'
5467 $ref: '#/components/responses/UnexpectedError'
5472 summary: Create a new SDN
5473 description: Create a new SDN
5474 operationId: createSDN
5476 $ref: '#/components/requestBodies/CreateSdnRequest'
5479 description: Accepted
5483 $ref: '#/components/schemas/ObjectId_plus_OpId'
5486 $ref: '#/components/schemas/ObjectId_plus_OpId'
5488 $ref: '#/components/responses/BadRequest'
5490 $ref: '#/components/responses/Unauthorized'
5492 $ref: '#/components/responses/Forbidden'
5494 $ref: '#/components/responses/NotFound'
5496 $ref: '#/components/responses/MethodNotAllowed'
5498 $ref: '#/components/responses/NotAcceptable'
5500 $ref: '#/components/responses/Conflict'
5502 $ref: '#/components/responses/UnprocessableEntity'
5504 $ref: '#/components/responses/InternalServerError'
5506 $ref: '#/components/responses/ServiceUnavailable'
5508 $ref: '#/components/responses/UnexpectedError'
5510 $ref: '#/components/responses/UnexpectedError'
5511 '/admin/v1/sdns/{sdnId}':
5524 summary: Query information about an individual SDN
5525 description: Query information about an individual SDN
5533 $ref: '#/components/schemas/SdnInfo'
5536 $ref: '#/components/schemas/SdnInfo'
5538 $ref: '#/components/responses/BadRequest'
5540 $ref: '#/components/responses/Unauthorized'
5542 $ref: '#/components/responses/Forbidden'
5544 $ref: '#/components/responses/NotFound'
5546 $ref: '#/components/responses/MethodNotAllowed'
5548 $ref: '#/components/responses/NotAcceptable'
5550 $ref: '#/components/responses/Conflict'
5552 $ref: '#/components/responses/UnprocessableEntity'
5554 $ref: '#/components/responses/InternalServerError'
5556 $ref: '#/components/responses/ServiceUnavailable'
5558 $ref: '#/components/responses/UnexpectedError'
5560 $ref: '#/components/responses/UnexpectedError'
5565 summary: Modify a SDN
5566 description: Modify a SDN
5567 operationId: editSDN
5569 $ref: '#/components/requestBodies/EditSdnRequest'
5572 description: Accepted
5576 $ref: '#/components/schemas/OpId'
5579 $ref: '#/components/schemas/OpId'
5581 $ref: '#/components/responses/BadRequest'
5583 $ref: '#/components/responses/Unauthorized'
5585 $ref: '#/components/responses/Forbidden'
5587 $ref: '#/components/responses/NotFound'
5589 $ref: '#/components/responses/MethodNotAllowed'
5591 $ref: '#/components/responses/NotAcceptable'
5593 $ref: '#/components/responses/Conflict'
5595 $ref: '#/components/responses/UnprocessableEntity'
5597 $ref: '#/components/responses/InternalServerError'
5599 $ref: '#/components/responses/ServiceUnavailable'
5601 $ref: '#/components/responses/UnexpectedError'
5603 $ref: '#/components/responses/UnexpectedError'
5608 summary: Delete a SDN
5609 description: Delete a SDN
5610 operationId: deleteSDN
5613 description: Accepted
5615 $ref: '#/components/responses/BadRequest'
5617 $ref: '#/components/responses/Unauthorized'
5619 $ref: '#/components/responses/Forbidden'
5621 $ref: '#/components/responses/NotFound'
5623 $ref: '#/components/responses/MethodNotAllowed'
5625 $ref: '#/components/responses/NotAcceptable'
5627 $ref: '#/components/responses/Conflict'
5629 $ref: '#/components/responses/UnprocessableEntity'
5631 $ref: '#/components/responses/InternalServerError'
5633 $ref: '#/components/responses/ServiceUnavailable'
5635 $ref: '#/components/responses/UnexpectedError'
5637 $ref: '#/components/responses/UnexpectedError'
5638 '/admin/v1/k8sclusters':
5643 summary: Query information about multiple K8s Clusters
5644 description: Query information about multiple K8s Clusters
5645 operationId: getK8sClusters
5652 $ref: '#/components/schemas/ArrayOfK8sClusterInfo'
5655 $ref: '#/components/schemas/ArrayOfK8sClusterInfo'
5657 $ref: '#/components/responses/BadRequest'
5659 $ref: '#/components/responses/Unauthorized'
5661 $ref: '#/components/responses/Forbidden'
5663 $ref: '#/components/responses/NotFound'
5665 $ref: '#/components/responses/MethodNotAllowed'
5667 $ref: '#/components/responses/NotAcceptable'
5669 $ref: '#/components/responses/Conflict'
5671 $ref: '#/components/responses/UnprocessableEntity'
5673 $ref: '#/components/responses/InternalServerError'
5675 $ref: '#/components/responses/ServiceUnavailable'
5677 $ref: '#/components/responses/UnexpectedError'
5679 $ref: '#/components/responses/UnexpectedError'
5684 summary: Create a new K8s Cluster
5685 description: Create a new K8s Cluster
5686 operationId: createK8sCluster
5688 $ref: '#/components/requestBodies/CreateK8sClusterRequest'
5691 description: Accepted
5695 $ref: '#/components/schemas/ObjectId_plus_OpId'
5698 $ref: '#/components/schemas/ObjectId_plus_OpId'
5700 $ref: '#/components/responses/BadRequest'
5702 $ref: '#/components/responses/Unauthorized'
5704 $ref: '#/components/responses/Forbidden'
5706 $ref: '#/components/responses/NotFound'
5708 $ref: '#/components/responses/MethodNotAllowed'
5710 $ref: '#/components/responses/NotAcceptable'
5712 $ref: '#/components/responses/Conflict'
5714 $ref: '#/components/responses/UnprocessableEntity'
5716 $ref: '#/components/responses/InternalServerError'
5718 $ref: '#/components/responses/ServiceUnavailable'
5720 $ref: '#/components/responses/UnexpectedError'
5722 $ref: '#/components/responses/UnexpectedError'
5723 '/admin/v1/k8sclusters/{k8sClusterId}':
5725 - name: k8sClusterId
5728 description: K8s Cluster ID
5736 summary: Query information about an individual K8s Cluster
5737 description: Query information about an individual K8s Cluster
5738 operationId: getK8sCluster
5745 $ref: '#/components/schemas/K8sClusterInfo'
5748 $ref: '#/components/schemas/K8sClusterInfo'
5750 $ref: '#/components/responses/BadRequest'
5752 $ref: '#/components/responses/Unauthorized'
5754 $ref: '#/components/responses/Forbidden'
5756 $ref: '#/components/responses/NotFound'
5758 $ref: '#/components/responses/MethodNotAllowed'
5760 $ref: '#/components/responses/NotAcceptable'
5762 $ref: '#/components/responses/Conflict'
5764 $ref: '#/components/responses/UnprocessableEntity'
5766 $ref: '#/components/responses/InternalServerError'
5768 $ref: '#/components/responses/ServiceUnavailable'
5770 $ref: '#/components/responses/UnexpectedError'
5772 $ref: '#/components/responses/UnexpectedError'
5777 summary: Modify a K8s Cluster
5778 description: Modify a K8s Cluster
5779 operationId: editK8sCluster
5781 $ref: '#/components/requestBodies/EditK8sClusterRequest'
5784 description: Accepted
5788 $ref: '#/components/schemas/OpId'
5791 $ref: '#/components/schemas/OpId'
5793 $ref: '#/components/responses/BadRequest'
5795 $ref: '#/components/responses/Unauthorized'
5797 $ref: '#/components/responses/Forbidden'
5799 $ref: '#/components/responses/NotFound'
5801 $ref: '#/components/responses/MethodNotAllowed'
5803 $ref: '#/components/responses/NotAcceptable'
5805 $ref: '#/components/responses/Conflict'
5807 $ref: '#/components/responses/UnprocessableEntity'
5809 $ref: '#/components/responses/InternalServerError'
5811 $ref: '#/components/responses/ServiceUnavailable'
5813 $ref: '#/components/responses/UnexpectedError'
5815 $ref: '#/components/responses/UnexpectedError'
5820 summary: Delete a K8s Cluster
5821 description: Delete a K8s Cluster
5822 operationId: deleteK8sCluster
5825 description: Accepted
5827 $ref: '#/components/responses/BadRequest'
5829 $ref: '#/components/responses/Unauthorized'
5831 $ref: '#/components/responses/Forbidden'
5833 $ref: '#/components/responses/NotFound'
5835 $ref: '#/components/responses/MethodNotAllowed'
5837 $ref: '#/components/responses/NotAcceptable'
5839 $ref: '#/components/responses/Conflict'
5841 $ref: '#/components/responses/UnprocessableEntity'
5843 $ref: '#/components/responses/InternalServerError'
5845 $ref: '#/components/responses/ServiceUnavailable'
5847 $ref: '#/components/responses/UnexpectedError'
5849 $ref: '#/components/responses/UnexpectedError'
5855 summary: Query information about multiple VCAs
5856 description: Query information about multiple VCAs
5857 operationId: getVcas
5864 $ref: '#/components/schemas/ArrayOfVcaInfo'
5867 $ref: '#/components/schemas/ArrayOfVcaInfo'
5869 $ref: '#/components/responses/BadRequest'
5871 $ref: '#/components/responses/Unauthorized'
5873 $ref: '#/components/responses/Forbidden'
5875 $ref: '#/components/responses/NotFound'
5877 $ref: '#/components/responses/MethodNotAllowed'
5879 $ref: '#/components/responses/NotAcceptable'
5881 $ref: '#/components/responses/Conflict'
5883 $ref: '#/components/responses/UnprocessableEntity'
5885 $ref: '#/components/responses/InternalServerError'
5887 $ref: '#/components/responses/ServiceUnavailable'
5889 $ref: '#/components/responses/UnexpectedError'
5891 $ref: '#/components/responses/UnexpectedError'
5896 summary: Create a new VCA
5897 description: Create a new VCA
5898 operationId: createVca
5900 $ref: '#/components/requestBodies/CreateVcaRequest'
5903 description: Accepted
5907 $ref: '#/components/schemas/ObjectId_plus_OpId'
5910 $ref: '#/components/schemas/ObjectId_plus_OpId'
5912 $ref: '#/components/responses/BadRequest'
5914 $ref: '#/components/responses/Unauthorized'
5916 $ref: '#/components/responses/Forbidden'
5918 $ref: '#/components/responses/NotFound'
5920 $ref: '#/components/responses/MethodNotAllowed'
5922 $ref: '#/components/responses/NotAcceptable'
5924 $ref: '#/components/responses/Conflict'
5926 $ref: '#/components/responses/UnprocessableEntity'
5928 $ref: '#/components/responses/InternalServerError'
5930 $ref: '#/components/responses/ServiceUnavailable'
5932 $ref: '#/components/responses/UnexpectedError'
5934 $ref: '#/components/responses/UnexpectedError'
5935 '/admin/v1/vca/{vcaId}':
5948 summary: Query information about an individual VCA
5949 description: Query information about an individual VCA
5957 $ref: '#/components/schemas/VcaInfo'
5960 $ref: '#/components/schemas/VcaInfo'
5962 $ref: '#/components/responses/BadRequest'
5964 $ref: '#/components/responses/Unauthorized'
5966 $ref: '#/components/responses/Forbidden'
5968 $ref: '#/components/responses/NotFound'
5970 $ref: '#/components/responses/MethodNotAllowed'
5972 $ref: '#/components/responses/NotAcceptable'
5974 $ref: '#/components/responses/Conflict'
5976 $ref: '#/components/responses/UnprocessableEntity'
5978 $ref: '#/components/responses/InternalServerError'
5980 $ref: '#/components/responses/ServiceUnavailable'
5982 $ref: '#/components/responses/UnexpectedError'
5984 $ref: '#/components/responses/UnexpectedError'
5989 summary: Modify a VCA
5990 description: Modify a VCA
5991 operationId: editVca
5993 $ref: '#/components/requestBodies/EditVcaRequest'
5996 description: Accepted
6000 $ref: '#/components/schemas/OpId'
6003 $ref: '#/components/schemas/OpId'
6005 $ref: '#/components/responses/BadRequest'
6007 $ref: '#/components/responses/Unauthorized'
6009 $ref: '#/components/responses/Forbidden'
6011 $ref: '#/components/responses/NotFound'
6013 $ref: '#/components/responses/MethodNotAllowed'
6015 $ref: '#/components/responses/NotAcceptable'
6017 $ref: '#/components/responses/Conflict'
6019 $ref: '#/components/responses/UnprocessableEntity'
6021 $ref: '#/components/responses/InternalServerError'
6023 $ref: '#/components/responses/ServiceUnavailable'
6025 $ref: '#/components/responses/UnexpectedError'
6027 $ref: '#/components/responses/UnexpectedError'
6032 summary: Delete a VCA
6033 description: Delete a VCA
6034 operationId: deleteVca
6037 description: Accepted
6039 $ref: '#/components/responses/BadRequest'
6041 $ref: '#/components/responses/Unauthorized'
6043 $ref: '#/components/responses/Forbidden'
6045 $ref: '#/components/responses/NotFound'
6047 $ref: '#/components/responses/MethodNotAllowed'
6049 $ref: '#/components/responses/NotAcceptable'
6051 $ref: '#/components/responses/Conflict'
6053 $ref: '#/components/responses/UnprocessableEntity'
6055 $ref: '#/components/responses/InternalServerError'
6057 $ref: '#/components/responses/ServiceUnavailable'
6059 $ref: '#/components/responses/UnexpectedError'
6061 $ref: '#/components/responses/UnexpectedError'
6062 '/admin/v1/k8srepos':
6067 summary: Query information about multiple K8s Repos
6068 description: Query information about multiple K8s Repos
6069 operationId: getK8sRepos
6076 $ref: '#/components/schemas/ArrayOfK8sRepoInfo'
6079 $ref: '#/components/schemas/ArrayOfK8sRepoInfo'
6081 $ref: '#/components/responses/BadRequest'
6083 $ref: '#/components/responses/Unauthorized'
6085 $ref: '#/components/responses/Forbidden'
6087 $ref: '#/components/responses/NotFound'
6089 $ref: '#/components/responses/MethodNotAllowed'
6091 $ref: '#/components/responses/NotAcceptable'
6093 $ref: '#/components/responses/Conflict'
6095 $ref: '#/components/responses/UnprocessableEntity'
6097 $ref: '#/components/responses/InternalServerError'
6099 $ref: '#/components/responses/ServiceUnavailable'
6101 $ref: '#/components/responses/UnexpectedError'
6103 $ref: '#/components/responses/UnexpectedError'
6108 summary: Create a new K8s Repo
6109 description: Create a new K8s Repo
6110 operationId: createK8sRepo
6112 $ref: '#/components/requestBodies/CreateK8sRepoRequest'
6115 description: Accepted
6119 $ref: '#/components/schemas/ObjectId_plus_OpId'
6122 $ref: '#/components/schemas/ObjectId_plus_OpId'
6124 $ref: '#/components/responses/BadRequest'
6126 $ref: '#/components/responses/Unauthorized'
6128 $ref: '#/components/responses/Forbidden'
6130 $ref: '#/components/responses/NotFound'
6132 $ref: '#/components/responses/MethodNotAllowed'
6134 $ref: '#/components/responses/NotAcceptable'
6136 $ref: '#/components/responses/Conflict'
6138 $ref: '#/components/responses/UnprocessableEntity'
6140 $ref: '#/components/responses/InternalServerError'
6142 $ref: '#/components/responses/ServiceUnavailable'
6144 $ref: '#/components/responses/UnexpectedError'
6146 $ref: '#/components/responses/UnexpectedError'
6147 '/admin/v1/k8srepos/{k8sRepoId}':
6152 description: K8s Repo ID
6160 summary: Query information about an individual K8s Repo
6161 description: Query information about an individual K8s Repo
6162 operationId: getK8sRepo
6169 $ref: '#/components/schemas/K8sRepoInfo'
6172 $ref: '#/components/schemas/K8sRepoInfo'
6174 $ref: '#/components/responses/BadRequest'
6176 $ref: '#/components/responses/Unauthorized'
6178 $ref: '#/components/responses/Forbidden'
6180 $ref: '#/components/responses/NotFound'
6182 $ref: '#/components/responses/MethodNotAllowed'
6184 $ref: '#/components/responses/NotAcceptable'
6186 $ref: '#/components/responses/Conflict'
6188 $ref: '#/components/responses/UnprocessableEntity'
6190 $ref: '#/components/responses/InternalServerError'
6192 $ref: '#/components/responses/ServiceUnavailable'
6194 $ref: '#/components/responses/UnexpectedError'
6196 $ref: '#/components/responses/UnexpectedError'
6201 summary: Delete a K8s Repo
6202 description: Delete a K8s Repo
6203 operationId: deleteK8sRepo
6206 description: Accepted
6208 $ref: '#/components/responses/BadRequest'
6210 $ref: '#/components/responses/Unauthorized'
6212 $ref: '#/components/responses/Forbidden'
6214 $ref: '#/components/responses/NotFound'
6216 $ref: '#/components/responses/MethodNotAllowed'
6218 $ref: '#/components/responses/NotAcceptable'
6220 $ref: '#/components/responses/Conflict'
6222 $ref: '#/components/responses/UnprocessableEntity'
6224 $ref: '#/components/responses/InternalServerError'
6226 $ref: '#/components/responses/ServiceUnavailable'
6228 $ref: '#/components/responses/UnexpectedError'
6230 $ref: '#/components/responses/UnexpectedError'
6234 description: Find out more about OSM
6235 url: 'https://osm.etsi.org/docs/user-guide/'
6240 description: Bad request. The server cannot process the request due to a client error.
6244 $ref: '#/components/schemas/ProblemDetails'
6246 description: Authorization information is missing or invalid.
6250 $ref: '#/components/schemas/ProblemDetails'
6252 description: Not enough permissions to do this operation.
6256 $ref: '#/components/schemas/ProblemDetails'
6258 description: The specified resource was not found.
6262 $ref: '#/components/schemas/ProblemDetails'
6264 description: This method is not supported for the requested resource.
6268 $ref: '#/components/schemas/ProblemDetails'
6270 description: The requested resource content cannot match the Accept headers sent in the request.
6274 $ref: '#/components/schemas/ProblemDetails'
6276 description: The operation cannot be executed currently, due to a conflict with the state of the resource.
6280 $ref: '#/components/schemas/ProblemDetails'
6281 UnprocessableEntity:
6282 description: The request was well-formed but was unable to be followed due to semantic errors.
6286 $ref: '#/components/schemas/ProblemDetails'
6287 InternalServerError:
6288 description: Internal server error.
6292 $ref: '#/components/schemas/ProblemDetails'
6294 description: Service temporarily unavailable.
6298 $ref: '#/components/schemas/ProblemDetails'
6300 description: Unexpected error.
6304 $ref: '#/components/schemas/ProblemDetails'
6306 description: VNF Descriptor (plaintext)
6310 $ref: '#/components/schemas/VnfDescriptor'
6312 description: VNF Package (compressed)
6316 $ref: '#/components/schemas/VnfPackage'
6318 description: NS Descriptor (plaintext)
6322 $ref: '#/components/schemas/NsDescriptor'
6324 description: NS Package (compressed)
6328 $ref: '#/components/schemas/NsPackage'
6330 description: NetSlice Template (plaintext)
6334 $ref: '#/components/schemas/NetSliceTemplate'
6336 description: NetSlice Package (compressed)
6340 $ref: '#/components/schemas/NetSlicePackage'
6341 NslcmSubscriptionResponse:
6342 description: NslcmSubscriptionResponse
6346 $ref: '#/components/schemas/NslcmSubscriptionResponse'
6349 $ref: '#/components/schemas/NslcmSubscriptionResponse'
6360 # A free list of key:value pairs
6362 additionalProperties: true
6369 CreateNsdInfoRequest:
6370 # A free list of key:value pairs
6372 additionalProperties: true
6373 NsdInfoModifications:
6375 NS Descriptor Information
6376 Only generic fields (id, name, description) are described
6377 For a full specification of the NS Descriptor see:
6378 http://osm-download.etsi.org/ftp/osm-doc/nsd.html
6382 description: NSD Identifier
6385 description: NSD Name
6388 description: NSD Description
6390 AlarmInfoModifications:
6399 description: To enable/disable the alarm.
6402 description: Threshold value of the Alarm
6406 NS Descriptor Information
6407 Only generic fields (_id, id, name, description) are described
6408 For a full specification of the NS Descriptor see:
6409 http://osm-download.etsi.org/ftp/osm-doc/nsd.html
6414 Identifier of the onboarded individual NS descriptor
6415 resource. This identifier is allocated by the NFVO.
6420 This identifier, which is allocated by the NSD
6421 designer, identifies the NSD in a globally unique
6422 way. It is copied from the NSD content and shall be
6423 present after the NSD content is on-boarded.
6427 Name of the onboarded NSD. This information is
6428 copied from the NSD content and shall be present
6429 after the NSD content is on-boarded.
6433 Description of the onboarded NSD.
6434 This information is copied from the NSD content.
6442 $ref: '#/components/schemas/NsdInfo'
6458 additionalProperties: true
6468 CreateVnfPkgInfoRequest:
6469 # A free list of key:value pairs
6471 additionalProperties: true
6472 VnfPkgInfoModifications:
6474 VNF Package Information
6475 Only generic fields (id, name, description) are described
6476 For a full specification of the VNF Descriptor see:
6477 http://osm-download.etsi.org/ftp/osm-doc/vnfd.html
6481 description: VNF Package Identifier
6484 description: VNF Package Name
6487 description: VNF Package description
6491 VNF Package Information
6492 Only generic fields (_id, id, name, description) are described
6493 For a full specification of the VNF Descriptor see:
6494 http://osm-download.etsi.org/ftp/osm-doc/vnfd.html
6499 Identifier of the VNF package. This identifier is allocated by the NFVO.
6503 description: VNF Package Identifier
6506 description: VNF Package Name
6509 description: VNF Package description
6517 $ref: '#/components/schemas/VnfPkgInfo'
6519 # Substituted by InstantiateNsRequest
6522 NS Instance Information
6523 Only generic fields (_id, id, name, description) are described
6524 For a full specification of the NS Instance see:
6525 http://osm-download.etsi.org/ftp/osm-doc/nsr.html
6529 description: Identifier of the NS instance.
6533 description: Identifier of the NS instance.
6537 description: Human readable name of the NS instance.
6540 description: Human readable description of the NS instance.
6546 InstantiateNsRequest:
6551 Human-readable name of the NS instance to be created.
6555 Identifier of the NSD that defines the NS instance to be created.
6560 Identifier of the VIM Account where the NS instance shall be created.
6579 additionalParamsForNs:
6581 additionalProperties: true
6582 additionalParamsForVnf: &additionalparamsforvnf
6591 additionalProperties: true
6595 use this namespace for all the KDU deployed in this VNF
6596 (if any). By default it is used the id of the project
6597 additionalParamsForVdu:
6606 additionalProperties: true
6610 additionalProperties: false
6611 additionalParamsForKdu:
6620 description: use this namespace for this KDU
6625 additionalProperties: true
6629 additionalProperties: false
6633 additionalProperties: false
6646 To compute automatically the target VIM for each VNF based on
6647 constrains, e.g. latency. Currently only 'PLA' is supported
6648 placement-constraints:
6650 additionalProperties: true
6684 additionalProperties: false
6699 floating-ip-required:
6703 additionalProperties: false
6707 additionalProperties: false
6746 additionalProperties: false
6760 additionalProperties: false
6762 additionalProperties: false
6774 connect additional ports to the created underlay SDN connectivity.
6775 Normally for external connectivy.
6789 additionalProperties: true
6794 additionalProperties: false
6795 internal-connection-point:
6808 additionalProperties: False
6813 additionalProperties: false
6818 additionalProperties: false
6837 additionalProperties: true
6845 additionalProperties: true
6853 additionalProperties: false
6854 vnfd-connection-point-ref:
6859 member-vnf-index-ref:
6861 vnfd-connection-point-ref:
6867 - member-vnf-index-ref
6868 - vnfd-connection-point-ref
6870 additionalProperties: false
6874 additionalProperties: false
6880 additionalProperties: false
6889 description: timeout for the scale operation
6902 scaling-group-descriptor:
6909 - scaling-group-descriptor
6911 additionalProperties: false
6915 additionalProperties: false
6919 additionalProperties: false
6922 This type represents request parameters for the "Heal NS" operation. This operation supports the healing of an NS
6923 instance by healing one or more of the VNF that are part of this NS.
6927 description: timeout for the heal operation in seconds
6931 List of VNF to be healed, together with the information needed to heal each.
6934 $ref: "#/components/schemas/HealVnfData"
6939 This type represents the information to heal a VNF that is part of an NS.
6946 Identifies the VNF instance, part of the NS, requiring a
6952 Indicates the reason why a healing procedure is required.
6956 Additional parameters passed by the NFVO as input to
6957 the healing process, specific to the VNF being healed.
6962 Flag to indicate whether or not to run day1 primitives for the VNF (default: false).
6967 List of VDU to be healed, together with the information needed to heal each.
6970 $ref: "#/components/schemas/HealVduData"
6973 This type represents the information to heal a VDU that is part of a VNF.
6980 Identifies the VDU id, part of the VNF, requiring a healing action.
6985 Indicates the VDU number when the VDU is part of a scale-group.
6990 Flag to indicate whether or not to run day1 primitives for the VDU (default: false).
6996 timeout_ns_terminate:
6997 description: timeout for terminate operation
7000 description: remove network service if termination end without error
7002 skip_terminate_primitives:
7003 description: Do not execute network service termination primitives
7005 additionalProperties: false
7009 $ref: '#/components/schemas/NsInstance'
7010 NSinstanceActionRequest:
7016 name of the primitive in the 'config-descriptor'. If the target is
7017 a kdu it can be also 'status', 'rollback' or 'upgrade'
7019 description: parameters of this primitive
7020 $ref: '#/components/schemas/KeyValuePairs'
7023 description: provide if the target action is for a vnf, vdu or kdu
7026 description: provide if the target action is for a vdu
7029 description: provide if the target action is for a kdu
7033 description: timeout for the day 1/2 operation
7038 additionalProperties: false
7039 # CreateNSinstanceContentRequest:
7040 # Substituted by InstantiateNsRequest
7041 CreateNSinstanceContentResponse:
7064 isAutomaticInvocation:
7106 $ref: '#/components/schemas/NsLcmOpOcc'
7109 VNF Instance Information
7110 Only generic fields (_id, id) are described
7111 For a full specification of the VNF Instance see:
7112 http://osm-download.etsi.org/ftp/osm-doc/vnfr.html
7121 ArrayOfVnfInstanceInfo:
7124 $ref: '#/components/schemas/VnfInstanceInfo'
7127 NetSlice Template Information
7128 Only generic fields (_id, id, name) are described
7129 For a full specification of the NetSlice Template see:
7130 http://osm-download.etsi.org/ftp/osm-doc/nst.html
7134 description: NetSlice Template Identifier
7138 description: Human readable NetSlice Template Identifier
7141 description: Human readable name of the NetSlice Template
7146 $ref: '#/components/schemas/NstInfo'
7147 CreateNstInfoRequest:
7148 # A free list of key:value pairs
7150 additionalProperties: true
7157 NstInfoModifications:
7159 NetSlice Template Information
7160 Only generic fields (id, name) are described
7161 For a full specification of the NetSlice Template see:
7162 http://osm-download.etsi.org/ftp/osm-doc/nst.html
7166 description: NST Identifier
7169 description: NST Name
7173 NetSlice Instance Information
7174 Only generic fields (_id, id, name, description) are described
7175 For a full specification of the NetSlice Instance see:
7176 http://osm-download.etsi.org/ftp/osm-doc/nsi.html
7180 description: Identifier of the NetSlice instance.
7184 description: Identifier of the NetSlice instance.
7188 description: Human readable name of the NetSlice instance.
7191 description: Human readable description of the NetSlice instance.
7197 ArrayOfNetSliceInstance:
7200 $ref: '#/components/schemas/NetSliceInstance'
7207 description: Identifier of the Alarm.
7211 description: Identifier of the Alarm.
7215 description: Alarm metric.
7218 description: Threshold value of the Alarm.
7222 description: Operation to be applied.
7225 description: Action to be taken.
7228 description: Current status of the alarm.
7239 $ref: '#/components/schemas/Alarm'
7241 # Substituted by InstantiateNsiRequest
7242 InstantiateNsiRequest:
7247 Human-readable name of the NetSlice instance to be created.
7251 Identifier of the NST that defines the NetSlice instance to be created.
7256 Identifier of the VIM Account where the NetSlice instance shall be created.
7272 additionalParamsForNsi:
7274 additionalProperties: true
7306 additionalParamsForNs:
7308 additionalProperties: true
7309 additionalParamsForVnf: *additionalparamsforvnf
7348 additionalProperties: false
7363 floating-ip-required:
7367 additionalProperties: false
7371 additionalProperties: false
7410 additionalProperties: false
7424 additionalProperties: false
7426 additionalProperties: false
7434 additionalProperties: false
7435 internal-connection-point:
7448 additionalProperties: False
7453 additionalProperties: false
7458 additionalProperties: false
7477 additionalProperties: true
7485 additionalProperties: true
7493 additionalProperties: false
7494 vnfd-connection-point-ref:
7499 member-vnf-index-ref:
7501 vnfd-connection-point-ref:
7507 - member-vnf-index-ref
7508 - vnfd-connection-point-ref
7510 additionalProperties: false
7514 additionalProperties: false
7516 additionalProperties: false
7535 additionalProperties: true
7538 additionalProperties: false
7544 additionalProperties: false
7545 TerminateNsiRequest:
7550 Timestamp indicating the end time of the NSI, i.e. the NSI will be terminated
7551 automatically at this timestamp. Cardinality "0" indicates the NSI termination
7552 takes place immediately.
7561 $ref: '#/components/schemas/KeyValuePairs'
7570 # CreateNsiContentRequest:
7571 # Substituted by InstantiateNsiRequest
7572 CreateNsiContentResponse:
7595 isAutomaticInvocation:
7642 $ref: '#/components/schemas/NsiLcmOpOcc'
7696 $ref: '#/components/schemas/TokenInfo'
7719 project_role_mappings:
7741 $ref: '#/components/schemas/UserInfo'
7742 ProjectRoleMappings:
7754 additionalProperties: false
7755 ProjectRoleMappingsOpt:
7766 additionalProperties: false
7778 project_role_mappings:
7779 $ref: '#/components/schemas/ProjectRoleMappings'
7783 additionalProperties: false
7790 additionalProperties: true
7793 Array edition keys must start with '$'
7794 and follow the syntax defined in: https://osm.etsi.org/wikipub/index.php/NBI_API_Description
7804 - $ref: '#/components/schemas/ShortNameList'
7805 - $ref: '#/components/schemas/ArrayEditionSchema'
7806 project_role_mappings:
7807 $ref: '#/components/schemas/ProjectRoleMappings'
7808 add_project_role_mappings:
7809 $ref: '#/components/schemas/ProjectRoleMappings'
7810 remove_project_role_mappings:
7811 $ref: '#/components/schemas/ProjectRoleMappingsOpt'
7867 additionalProperties: false
7923 additionalProperties: false
7933 $ref: '#/components/schemas/QuotasInfo'
7937 $ref: '#/components/schemas/ProjectInfo'
7938 CreateProjectRequest:
7946 $ref: '#/components/schemas/QuotasInfo'
7949 additionalProperties: false
7958 $ref: '#/components/schemas/EditQuotasInfo'
7959 additionalProperties: false
7962 additionalProperties:
7966 Permissions keys must follow the syntax 'main_topic[:subtopic[:id[:component|action|etc]]]'
7967 Permission values are either true or false
7968 EditPermissionsInfo:
7970 additionalProperties:
7974 Permissions keys must follow the syntax 'main_topic[:subtopic[:id[:component|action|etc]]]'
7975 Permission values are either true, false, or null
7985 $ref: '#/components/schemas/PermissionsInfo'
7989 $ref: '#/components/schemas/RoleInfo'
7996 $ref: '#/components/schemas/PermissionsInfo'
7999 additionalProperties: false
8006 $ref: '#/components/schemas/EditPermissionsInfo'
8007 additionalProperties: false
8038 $ref: '#/components/schemas/VimType'
8053 additionalProperties: true
8059 $ref: '#/components/schemas/VimInfo'
8077 $ref: '#/components/schemas/VimType'
8092 additionalProperties: true
8102 additionalProperties: false
8115 $ref: '#/components/schemas/VimType'
8130 additionalProperties: true
8131 additionalProperties: false
8173 $ref: '#/components/schemas/WimType'
8183 additionalProperties: true
8187 $ref: '#/components/schemas/WimInfo'
8203 $ref: '#/components/schemas/WimType'
8213 additionalProperties: true
8218 additionalProperties: false
8239 additionalProperties: true
8240 additionalProperties: false
8279 - $ref: '#/components/schemas/SdnExtraProperties'
8280 - $ref: '#/components/schemas/SdnBasicProperties'
8284 $ref: '#/components/schemas/SdnInfo'
8287 - $ref: '#/components/schemas/SdnBasicProperties'
8294 additionalProperties: false
8297 - $ref: '#/components/schemas/SdnBasicProperties'
8298 additionalProperties: false
8354 additionalProperties: false
8378 $ref: '#/components/schemas/PduInterfaces'
8382 $ref: '#/components/schemas/PduInfo'
8403 $ref: '#/components/schemas/PduInterfaces'
8408 additionalProperties: false
8429 $ref: '#/components/schemas/PduInterfaces'
8430 additionalProperties: false
8435 additionalProperties: true
8453 additionalProperties: true
8460 $ref: '#/components/schemas/K8sClusterNetList'
8467 ArrayOfK8sClusterInfo:
8470 $ref: '#/components/schemas/K8sClusterInfo'
8471 CreateK8sClusterRequest:
8485 additionalProperties: true
8492 $ref: '#/components/schemas/K8sClusterNetList'
8505 additionalProperties: false
8506 EditK8sClusterRequest:
8515 additionalProperties: true
8522 $ref: '#/components/schemas/K8sClusterNetList'
8529 additionalProperties: false
8563 additionalProperties: true
8567 $ref: '#/components/schemas/VcaInfo'
8598 additionalProperties: true
8609 additionalProperties: false
8635 additionalProperties: true
8636 additionalProperties: false
8653 $ref: '#/components/schemas/K8sRepoType'
8659 description: repository username
8662 description: repository password
8665 description: verify certificates of HTTPS-enabled servers using this CA bundle
8668 description: identify HTTPS client using this SSL certificate file
8671 description: skip tls certificate checks for the repository
8674 description: identify HTTPS client using this SSL key file
8678 $ref: '#/components/schemas/K8sRepoInfo'
8679 CreateK8sRepoRequest:
8687 $ref: '#/components/schemas/K8sRepoType'
8695 additionalProperties: false
8696 NslcmSubscriptionResponse:
8709 NslcmSubscriptionInfo:
8726 $ref: '#/components/schemas/Authenticationschema'
8727 ArrayOfNslcmSubscriptionInfo:
8730 $ref: '#/components/schemas/NslcmSubscriptionInfo'
8731 NsInstanceSubscriptionFilter:
8733 used to identify the network service
8736 - $ref: '#/components/schemas/nsdIds'
8737 - $ref: '#/components/schemas/vnfdIds'
8738 - $ref: '#/components/schemas/pnfdIds'
8739 - $ref: '#/components/schemas/nsInstanceIds'
8740 - $ref: '#/components/schemas/nsInstanceNames'
8764 nsInstanceSubscriptionFilter:
8765 $ref: '#/components/schemas/NsInstanceSubscriptionFilter'
8768 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
8773 - NsIdentifierCreationNotification
8774 - NsIdentifierDeletionNotification
8775 - NsLcmOperationOccurrenceNotification
8776 - NsChangeNotification
8794 - PARTIALLY_COMPLETED
8807 lcmOpNameImpactingNsComponent:
8814 - VNF_SCALE_TO_LEVEL
8815 - VNF_CHANGE_FLAVOUR
8819 - VNF_CHANGE_EXT_CONN
8826 lcmOpOccStatusImpactingNsComponent:
8833 - PARTIALLY_COMPLETED
8836 Authenticationschema:
8850 NslcmSubscriptionRequest:
8854 $ref: '#/components/schemas/Nslcmsubschema'
8859 $ref: '#/components/schemas/Authenticationschema'
8865 CreateNsdInfoRequest:
8869 $ref: '#/components/schemas/CreateNsdInfoRequest'
8872 $ref: '#/components/schemas/CreateNsdInfoRequest'
8873 NsdInfoModifications:
8877 $ref: '#/components/schemas/NsdInfoModifications'
8880 $ref: '#/components/schemas/NsdInfoModifications'
8881 AlarmInfoModifications:
8885 $ref: '#/components/schemas/AlarmInfoModifications'
8888 $ref: '#/components/schemas/AlarmInfoModifications'
8893 $ref: '#/components/schemas/NsDescriptor'
8898 $ref: '#/components/schemas/NsPackage'
8899 CreateVnfPkgInfoRequest:
8903 $ref: '#/components/schemas/CreateVnfPkgInfoRequest'
8906 $ref: '#/components/schemas/CreateVnfPkgInfoRequest'
8907 VnfPkgInfoModifications:
8911 $ref: '#/components/schemas/VnfPkgInfoModifications'
8914 $ref: '#/components/schemas/VnfPkgInfoModifications'
8919 $ref: '#/components/schemas/VnfPackage'
8924 $ref: '#/components/schemas/VnfDescriptor'
8926 # Substituted by InstantiateNsRequest
8927 InstantiateNsRequest:
8931 $ref: '#/components/schemas/InstantiateNsRequest'
8934 $ref: '#/components/schemas/InstantiateNsRequest'
8939 $ref: '#/components/schemas/HealNsRequest'
8942 $ref: '#/components/schemas/HealNsRequest'
8947 $ref: '#/components/schemas/ScaleNsRequest'
8950 $ref: '#/components/schemas/ScaleNsRequest'
8955 $ref: '#/components/schemas/TerminateNsRequest'
8958 $ref: '#/components/schemas/TerminateNsRequest'
8959 # CreateNSinstanceContentRequest:
8960 # Substituted by InstantiateNsRequest
8961 CreateNstInfoRequest:
8965 $ref: '#/components/schemas/CreateNstInfoRequest'
8968 $ref: '#/components/schemas/CreateNstInfoRequest'
8973 $ref: '#/components/schemas/NetSliceTemplate'
8978 $ref: '#/components/schemas/NetSlicePackage'
8979 NstInfoModifications:
8983 $ref: '#/components/schemas/NstInfoModifications'
8986 $ref: '#/components/schemas/NstInfoModifications'
8988 # Substituted by InstantiateNsiRequest
8989 InstantiateNsiRequest:
8993 $ref: '#/components/schemas/InstantiateNsiRequest'
8996 $ref: '#/components/schemas/InstantiateNsiRequest'
8997 TerminateNsiRequest:
9001 $ref: '#/components/schemas/TerminateNsiRequest'
9004 $ref: '#/components/schemas/TerminateNsiRequest'
9009 $ref: '#/components/schemas/NsiActionRequest'
9012 $ref: '#/components/schemas/NsiActionRequest'
9013 # CreateNsiContentRequest:
9014 # Substituted by InstantiateNsiRequest
9019 $ref: '#/components/schemas/CreateTokenRequest'
9022 $ref: '#/components/schemas/CreateTokenRequest'
9027 $ref: '#/components/schemas/CreateUserRequest'
9030 $ref: '#/components/schemas/CreateUserRequest'
9035 $ref: '#/components/schemas/EditUserRequest'
9038 $ref: '#/components/schemas/EditUserRequest'
9039 CreateProjectRequest:
9043 $ref: '#/components/schemas/CreateProjectRequest'
9046 $ref: '#/components/schemas/CreateProjectRequest'
9051 $ref: '#/components/schemas/EditProjectRequest'
9054 $ref: '#/components/schemas/EditProjectRequest'
9059 $ref: '#/components/schemas/CreateRoleRequest'
9062 $ref: '#/components/schemas/CreateRoleRequest'
9067 $ref: '#/components/schemas/EditRoleRequest'
9070 $ref: '#/components/schemas/EditRoleRequest'
9075 $ref: '#/components/schemas/CreateVimRequest'
9078 $ref: '#/components/schemas/CreateVimRequest'
9083 $ref: '#/components/schemas/EditVimRequest'
9086 $ref: '#/components/schemas/EditVimRequest'
9091 $ref: '#/components/schemas/CreateWimRequest'
9094 $ref: '#/components/schemas/CreateWimRequest'
9099 $ref: '#/components/schemas/EditWimRequest'
9102 $ref: '#/components/schemas/EditWimRequest'
9107 $ref: '#/components/schemas/CreateSdnRequest'
9110 $ref: '#/components/schemas/CreateSdnRequest'
9115 $ref: '#/components/schemas/EditSdnRequest'
9118 $ref: '#/components/schemas/EditSdnRequest'
9123 $ref: '#/components/schemas/CreatePduRequest'
9126 $ref: '#/components/schemas/CreatePduRequest'
9131 $ref: '#/components/schemas/EditPduRequest'
9134 $ref: '#/components/schemas/EditPduRequest'
9135 CreateK8sClusterRequest:
9139 $ref: '#/components/schemas/CreateK8sClusterRequest'
9142 $ref: '#/components/schemas/CreateK8sClusterRequest'
9143 EditK8sClusterRequest:
9147 $ref: '#/components/schemas/EditK8sClusterRequest'
9150 $ref: '#/components/schemas/EditK8sClusterRequest'
9155 $ref: '#/components/schemas/CreateVcaRequest'
9158 $ref: '#/components/schemas/CreateVcaRequest'
9163 $ref: '#/components/schemas/EditVcaRequest'
9166 $ref: '#/components/schemas/EditVcaRequest'
9167 CreateK8sRepoRequest:
9171 $ref: '#/components/schemas/CreateK8sRepoRequest'
9174 $ref: '#/components/schemas/CreateK8sRepoRequest'
9175 NslcmSubscriptionRequest:
9179 $ref: '#/components/schemas/NslcmSubscriptionRequest'
9182 $ref: '#/components/schemas/NslcmSubscriptionRequest'
9183 # END REQUEST BODIES